---
title: "Financial"
url: "https://developer.pexa.co.uk/apis/financials-v1-v1/versions/d3f169b2-8b77-47f6-8696-d6efa1bd09f2"
---

# Financial

OpenAPI specification document.

```json
{"openapi":"3.0.1","info":{"title":"Financial","description":"This API product gives all the possible functionalities we can perform on financials like add, update, delete financial line items, funds authorization and set completion date.","version":"v1","x-api-version":"1.1.0","x-pexa-products":["partner"],"x-pexa-segments":["lawfirms","lenders"],"x-idp-audience":"PexaPartnerAPI","x-idp-audience-identifier":"https://app.pexauk.co.uk/api/v1/pexa-partner"},"servers":[{"url":"https://api.pexa.co.uk","description":"API Gateway URL"}],"tags":[{"name":"Financial","description":"This API product gives all the possible functionalities we can perform on financials like add, update, delete financial line items, funds authorization and set completion date"}],"paths":{"/partner/api/platformconnect/v1/workspaces/{workspace_id}/funds-authorisation":{"post":{"tags":["Settlement"],"summary":"Funds Authorisation","description":"This API is used to authorise/un-authorise the fss source line item for a workspace","operationId":"fundsAuthorisation","security":[{"oauth2":["x-api:authorise:funds","authorise:funds"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["completionDate","lineItem"],"properties":{"completionDate":{"type":"string","format":"date","example":"1970-12-31"},"lineItem":{"type":"object","required":["authorised","category","amount"],"properties":{"authorised":{"type":"boolean","example":true,"description":"Authorisation status of the line item"},"category":{"type":"string","pattern":"^(Mortgage Advance)$","description":"Allowed values:\n [`Mortgage Advance`]\n","example":"Mortgage Advance"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10}}}}}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"matched":{"type":"boolean","example":true},"authorised":{"type":"boolean","example":true,"description":"Authorisation status of the line item"}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"amount","message":"Amount mismatch"}]}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Resource not found for: workspace id"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/financial-settlement-schedules/{financialSettlementScheduleId}/line-items":{"post":{"tags":["lineItem"],"summary":"Add Financial Line Item","description":"This API is used in conjunction with 'Fetch financial settlement schedules' API  to create an individual funds source or destination line item","operationId":"createLineItem","security":[{"oauth2":["add:fss_line_items"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"financialSettlementScheduleId","in":"path","required":true,"description":"Financial Settlement Schedule id for which lineItems are created","schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"hasLinkedAccount":{"type":"boolean","description":"Flag to indicate whether account is linked to a financial account"}},"required":["type","amount","reference","category"]},"examples":{"CreateSourceLineItem":{"value":{"type":"SOURCE","amount":100,"reference":"test reference","category":"Mortgage Advance"}},"CreateDestinationLineItem":{"value":{"amount":100,"type":"DESTINATION","reference":"test reference","category":"Redemption","bankAccount":{"accountName":"xyz account","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"hasLinkedAccount":false}}}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"examples":{"SourceLineItem":{"value":{"data":{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},"errors":[]}},"DestinationLineItem":{"value":{"data":{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false},"errors":[]}},"DestinationLineItemWithLinkedAccount":{"value":{"data":{"lineItemId":"85f301f6-11d2-4fc2-bd7f-17af37df1192","amount":10,"type":"DESTINATION","authorised":null,"reference":"hh","category":"Redemption","lineItemReference":"PEXA230044822D01","bankAccount":{"accountName":"ReportsUpdates","accountNumber":"52352322","bankCode":"543253","accountType":"BUSINESS","displayName":"API394"},"verificationDetail":null,"hasLinkedAccount":true},"errors":[]}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"examples":{"SourceLineItem":{"value":{"error":{"field":"type","message":"type must be one of [SOURCE, DESTINATION]"}}},"DestinationLineItem":{"value":{"error":{"field":"bankAccount","message":"field is missing"}}},"DestinationLineItemWithLinkedAccount":{"value":{"error":{"field":"amount","message":"field is missing"}}}}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"examples":{"SourceLineItem":{"value":{"errors":[{"message":"Internal Server Error"}]}},"DestinationLineItem":{"value":{"errors":[{"message":"Internal Server Error"}]}},"DestinationLineItemWithLinkedAccount":{"value":{"errors":[{"message":"Internal Server Error"}]}}}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/financial-settlement-schedules/{financialSettlementScheduleId}/line-items/{lineItemId}":{"patch":{"tags":["lineItem"],"summary":"Update Financial Line Item","description":"This API is used in conjunction with 'Fetch financial settlement schedules' API to update data in an existing line item","operationId":"updateLineItem","security":[{"oauth2":["edit:fss_line_items"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"financialSettlementScheduleId","in":"path","required":true,"description":"Financial Settlement Schedule id for which lineItems are updated","schema":{"type":"string","format":"uuid"}},{"name":"lineItemId","in":"path","required":true,"description":"Line Item Id for which update has to happen","schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"}}},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"}}},"examples":{"UpdateBankAccount":{"value":{"bankAccount":{"accountName":"accountA","accountNumber":"12345678","bankCode":"123456"}}},"UpdateAmount":{"value":{"amount":123456}},"UpdateReference":{"value":{"reference":"sample"}}}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"examples":{"UpdateBankAccount":{"value":{"data":{"lineItemId":"c7c0ee40-25c1-11ec-9621-0242ac130002","type":"DESTINATION","amount":100,"authorised":true,"reference":"Nation wide","category":"Settlement","lineItemReference":"PEXA220000003D01","bankAccount":{"accountName":"accountA","accountNumber":"12345678","bankCode":"123456","accountType":"BUSINESS","displayName":"Mortgage account"},"verificationDetail":{"status":"MATCH","verified":true,"acceptedAt":"2022-01-01T00:00:00Z","acceptedBy":"c7c0ee40-25c1-11ec-9621-0242ac130002","actualName":"accountA","isManualOverrideAllowed":false},"hasLinkedAccount":true},"errors":[]}},"UpdateAmount":{"value":{"data":{"lineItemId":"c7c0ee40-25c1-11ec-9621-0242ac130002","type":"DESTINATION","amount":100,"authorised":true,"reference":"Nation wide","category":"Settlement","lineItemReference":"PEXA220000003D01","bankAccount":{"accountName":"accountA","accountNumber":"12345678","bankCode":"123456","accountType":"BUSINESS","displayName":"Mortgage account"},"verificationDetail":{"status":"MATCH","verified":true,"acceptedAt":"2022-01-01T00:00:00Z","acceptedBy":"c7c0ee40-25c1-11ec-9621-0242ac130002","actualName":"accountA","isManualOverrideAllowed":false},"hasLinkedAccount":true},"errors":[]}},"UpdateReference":{"value":{"data":{"lineItemId":"c7c0ee40-25c1-11ec-9621-0242ac130002","type":"DESTINATION","amount":100,"authorised":true,"reference":"Nation wide","category":"Settlement","lineItemReference":"PEXA220000003D01","bankAccount":{"accountName":"accountA","accountNumber":"12345678","bankCode":"123456","accountType":"BUSINESS","displayName":"Mortgage account"},"verificationDetail":{"status":"MATCH","verified":true,"acceptedAt":"2022-01-01T00:00:00Z","acceptedBy":"c7c0ee40-25c1-11ec-9621-0242ac130002","actualName":"accountA","isManualOverrideAllowed":false},"hasLinkedAccount":true},"errors":[]}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"examples":{"UpdateBankAccount":{"value":{"errors":[{"field":"accountNumber","message":"account number is not in valid format"}]}},"UpdateAmount":{"value":{"errors":[{"field":"amount","message":"amount cannot be empty"}]}},"UpdateReference":{"value":{"errors":[{"field":"reference","message":"invalid reference"}]}}}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"examples":{"UpdateBankAccount500StatusDefaultError":{"value":{"errors":[{"message":"Internal server error"}]}},"UpdateAmount500StatusDefaultError":{"value":{"errors":[{"message":"Internal server error"}]}},"UpdateReference500StatusDefaultError":{"value":{"errors":[{"message":"Internal server error"}]}}}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}},"delete":{"tags":["lineItem"],"summary":"Delete Financial Line Item","description":"This API is used to delete the existing source and destination line item","operationId":"deleteLineItem","security":[{"oauth2":["delete:fss_line_items"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"financialSettlementScheduleId","in":"path","required":true,"description":"Financial Settlement Schedule id for which lineItem need to be deleted","schema":{"type":"string","format":"uuid"}},{"name":"lineItemId","in":"path","required":true,"description":"Line Item Id for which delete need to happen","schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"NO_CONTENT","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}}},"400":{"description":"BAD_REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"lineItemId","message":"lineItemId is not in UUID format"}]}}}},"401":{"description":"UNAUTHORISED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"WWW-Authenticate":{"schema":{"type":"string"},"description":"Contains token level error description (Ex - Token Expired, Invalid Audience)"}}},"500":{"description":"INTERNAL_SERVER_ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/financial-settlement-schedules":{"get":{"tags":["FinancialSettlementSchedule"],"summary":"Get Financial Settlement Schedule","description":"This API is used by Law Firms to fetch Financial Settlement Schedule information. This includes the funds source and destination line items and completion date.\n\nThe API provides the Financial Settlement Schedule ID which can be used in conjunction with the additional Settlement Service APIs to add or update existing financial settlement schedule details.\n","operationId":"fetchFinancialSettlementSchedule","security":[{"oauth2":["view:financial_settlement_schedules"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"query","description":"Unique identifier of the Workspace entity for which financial settlement schedule need to be fetched","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"financialSettlementScheduleId":{"type":"string","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ab130002"},"workspaceId":{"type":"string","description":"UUID of the corresponding workspace","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"workspaceStatus":{"type":"string","description":"Status of workspace to which the financial settlement schedule belongs","example":"PREPARED"},"completionDate":{"type":"string","description":"settlement completion date, yyyy-mm-dd (format)","format":"date"},"approvals":{"default":[],"type":"array","items":{"type":"object","properties":{"participantId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"isApproved":{"type":"boolean","example":true}}},"example":[{"participantId":"59a02f78-79c2-49ff-b27f-5606b4cda762","isApproved":true}]},"status":{"type":"string","description":"financial settlement schedule status","example":"Prepared"},"workspaceReferenceId":{"type":"string","description":"Reference Id of the corresponding workspace","example":"PEXA220000001"},"hardLocked":{"type":"boolean","description":"Hard locked status of the workspace","example":false},"held":{"type":"boolean","description":"Held status of financial settlement schedule","example":false},"settlementReference":{"type":"string","description":"Reference of the associated settlement","example":"PEXA081220211105"},"slotTime":{"type":"string","description":"slot time at which financial settlement schedule will settle","example":880},"amountPayableOnCompletion":{"type":"number","description":"Amount payable to the seller representative on completion in S&P transaction","example":100},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"example":[{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false}]},"participants":{"default":[],"type":"array","items":{"type":"object","properties":{"subscriberId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"role":{"type":"string","example":"INCOMING_LENDER"}}}}},"required":["financialSettlementScheduleId"]}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"202":{"description":"ACCEPTED - Resource is being set up. Client should retry after a short delay.","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"financialSettlementScheduleId":{"type":"string","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ab130002"},"workspaceId":{"type":"string","description":"UUID of the corresponding workspace","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"workspaceStatus":{"type":"string","description":"Status of workspace to which the financial settlement schedule belongs","example":"PREPARED"},"completionDate":{"type":"string","description":"settlement completion date, yyyy-mm-dd (format)","format":"date"},"approvals":{"default":[],"type":"array","items":{"type":"object","properties":{"participantId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"isApproved":{"type":"boolean","example":true}}},"example":[{"participantId":"59a02f78-79c2-49ff-b27f-5606b4cda762","isApproved":true}]},"status":{"type":"string","description":"financial settlement schedule status","example":"Prepared"},"workspaceReferenceId":{"type":"string","description":"Reference Id of the corresponding workspace","example":"PEXA220000001"},"hardLocked":{"type":"boolean","description":"Hard locked status of the workspace","example":false},"held":{"type":"boolean","description":"Held status of financial settlement schedule","example":false},"settlementReference":{"type":"string","description":"Reference of the associated settlement","example":"PEXA081220211105"},"slotTime":{"type":"string","description":"slot time at which financial settlement schedule will settle","example":880},"amountPayableOnCompletion":{"type":"number","description":"Amount payable to the seller representative on completion in S&P transaction","example":100},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"example":[{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false}]},"participants":{"default":[],"type":"array","items":{"type":"object","properties":{"subscriberId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"role":{"type":"string","example":"INCOMING_LENDER"}}}}},"required":["financialSettlementScheduleId"]}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":null,"message":"Resource being set up. Please try again after a few seconds."}]}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"financialSettlementScheduleId":{"type":"string","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ab130002"},"workspaceId":{"type":"string","description":"UUID of the corresponding workspace","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"workspaceStatus":{"type":"string","description":"Status of workspace to which the financial settlement schedule belongs","example":"PREPARED"},"completionDate":{"type":"string","description":"settlement completion date, yyyy-mm-dd (format)","format":"date"},"approvals":{"default":[],"type":"array","items":{"type":"object","properties":{"participantId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"isApproved":{"type":"boolean","example":true}}},"example":[{"participantId":"59a02f78-79c2-49ff-b27f-5606b4cda762","isApproved":true}]},"status":{"type":"string","description":"financial settlement schedule status","example":"Prepared"},"workspaceReferenceId":{"type":"string","description":"Reference Id of the corresponding workspace","example":"PEXA220000001"},"hardLocked":{"type":"boolean","description":"Hard locked status of the workspace","example":false},"held":{"type":"boolean","description":"Held status of financial settlement schedule","example":false},"settlementReference":{"type":"string","description":"Reference of the associated settlement","example":"PEXA081220211105"},"slotTime":{"type":"string","description":"slot time at which financial settlement schedule will settle","example":880},"amountPayableOnCompletion":{"type":"number","description":"Amount payable to the seller representative on completion in S&P transaction","example":100},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"example":[{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false}]},"participants":{"default":[],"type":"array","items":{"type":"object","properties":{"subscriberId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"role":{"type":"string","example":"INCOMING_LENDER"}}}}},"required":["financialSettlementScheduleId"]}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"workspaceId","message":"workspaceId has to be a UUID"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"financialSettlementScheduleId":{"type":"string","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ab130002"},"workspaceId":{"type":"string","description":"UUID of the corresponding workspace","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"workspaceStatus":{"type":"string","description":"Status of workspace to which the financial settlement schedule belongs","example":"PREPARED"},"completionDate":{"type":"string","description":"settlement completion date, yyyy-mm-dd (format)","format":"date"},"approvals":{"default":[],"type":"array","items":{"type":"object","properties":{"participantId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"isApproved":{"type":"boolean","example":true}}},"example":[{"participantId":"59a02f78-79c2-49ff-b27f-5606b4cda762","isApproved":true}]},"status":{"type":"string","description":"financial settlement schedule status","example":"Prepared"},"workspaceReferenceId":{"type":"string","description":"Reference Id of the corresponding workspace","example":"PEXA220000001"},"hardLocked":{"type":"boolean","description":"Hard locked status of the workspace","example":false},"held":{"type":"boolean","description":"Held status of financial settlement schedule","example":false},"settlementReference":{"type":"string","description":"Reference of the associated settlement","example":"PEXA081220211105"},"slotTime":{"type":"string","description":"slot time at which financial settlement schedule will settle","example":880},"amountPayableOnCompletion":{"type":"number","description":"Amount payable to the seller representative on completion in S&P transaction","example":100},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"example":[{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false}]},"participants":{"default":[],"type":"array","items":{"type":"object","properties":{"subscriberId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"role":{"type":"string","example":"INCOMING_LENDER"}}}}},"required":["financialSettlementScheduleId"]},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal server error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/financial-settlement-schedules/{financialSettlementScheduleId}":{"patch":{"tags":["financialSettlementSchedule"],"summary":"Set Completion Date","description":"This API is used in conjunction with 'Fetch financial settlement schedules' API  to set or update the completion date","operationId":"updateCompletionDate","security":[{"oauth2":["edit:financial_settlement_schedules"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"financialSettlementScheduleId","in":"path","required":true,"description":"Unique identifier for Financial Settlement Schedule id","schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"completionDate":{"type":"string","format":"date","example":"1970-12-31"}},"required":["completionDate"]}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"financialSettlementScheduleId":{"type":"string","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ab130002"},"workspaceId":{"type":"string","description":"UUID of the corresponding workspace","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"workspaceStatus":{"type":"string","description":"Status of workspace to which the financial settlement schedule belongs","example":"PREPARED"},"completionDate":{"type":"string","description":"settlement completion date, yyyy-mm-dd (format)","format":"date"},"approvals":{"default":[],"type":"array","items":{"type":"object","properties":{"participantId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"isApproved":{"type":"boolean","example":true}}},"example":[{"participantId":"59a02f78-79c2-49ff-b27f-5606b4cda762","isApproved":true}]},"status":{"type":"string","description":"financial settlement schedule status","example":"Prepared"},"workspaceReferenceId":{"type":"string","description":"Reference Id of the corresponding workspace","example":"PEXA220000001"},"hardLocked":{"type":"boolean","description":"Hard locked status of the workspace","example":false},"held":{"type":"boolean","description":"Held status of financial settlement schedule","example":false},"settlementReference":{"type":"string","description":"Reference of the associated settlement","example":"PEXA081220211105"},"slotTime":{"type":"string","description":"slot time at which financial settlement schedule will settle","example":880},"amountPayableOnCompletion":{"type":"number","description":"Amount payable to the seller representative on completion in S&P transaction","example":100},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"example":[{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false}]},"participants":{"default":[],"type":"array","items":{"type":"object","properties":{"subscriberId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"role":{"type":"string","example":"INCOMING_LENDER"}}}}},"required":["financialSettlementScheduleId"]},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"financialSettlementScheduleId":{"type":"string","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ab130002"},"workspaceId":{"type":"string","description":"UUID of the corresponding workspace","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"workspaceStatus":{"type":"string","description":"Status of workspace to which the financial settlement schedule belongs","example":"PREPARED"},"completionDate":{"type":"string","description":"settlement completion date, yyyy-mm-dd (format)","format":"date"},"approvals":{"default":[],"type":"array","items":{"type":"object","properties":{"participantId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"isApproved":{"type":"boolean","example":true}}},"example":[{"participantId":"59a02f78-79c2-49ff-b27f-5606b4cda762","isApproved":true}]},"status":{"type":"string","description":"financial settlement schedule status","example":"Prepared"},"workspaceReferenceId":{"type":"string","description":"Reference Id of the corresponding workspace","example":"PEXA220000001"},"hardLocked":{"type":"boolean","description":"Hard locked status of the workspace","example":false},"held":{"type":"boolean","description":"Held status of financial settlement schedule","example":false},"settlementReference":{"type":"string","description":"Reference of the associated settlement","example":"PEXA081220211105"},"slotTime":{"type":"string","description":"slot time at which financial settlement schedule will settle","example":880},"amountPayableOnCompletion":{"type":"number","description":"Amount payable to the seller representative on completion in S&P transaction","example":100},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"example":[{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false}]},"participants":{"default":[],"type":"array","items":{"type":"object","properties":{"subscriberId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"role":{"type":"string","example":"INCOMING_LENDER"}}}}},"required":["financialSettlementScheduleId"]},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"completionDate","message":"field is missing"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"financialSettlementScheduleId":{"type":"string","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ab130002"},"workspaceId":{"type":"string","description":"UUID of the corresponding workspace","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"workspaceStatus":{"type":"string","description":"Status of workspace to which the financial settlement schedule belongs","example":"PREPARED"},"completionDate":{"type":"string","description":"settlement completion date, yyyy-mm-dd (format)","format":"date"},"approvals":{"default":[],"type":"array","items":{"type":"object","properties":{"participantId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"isApproved":{"type":"boolean","example":true}}},"example":[{"participantId":"59a02f78-79c2-49ff-b27f-5606b4cda762","isApproved":true}]},"status":{"type":"string","description":"financial settlement schedule status","example":"Prepared"},"workspaceReferenceId":{"type":"string","description":"Reference Id of the corresponding workspace","example":"PEXA220000001"},"hardLocked":{"type":"boolean","description":"Hard locked status of the workspace","example":false},"held":{"type":"boolean","description":"Held status of financial settlement schedule","example":false},"settlementReference":{"type":"string","description":"Reference of the associated settlement","example":"PEXA081220211105"},"slotTime":{"type":"string","description":"slot time at which financial settlement schedule will settle","example":880},"amountPayableOnCompletion":{"type":"number","description":"Amount payable to the seller representative on completion in S&P transaction","example":100},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"example":[{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false}]},"participants":{"default":[],"type":"array","items":{"type":"object","properties":{"subscriberId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"role":{"type":"string","example":"INCOMING_LENDER"}}}}},"required":["financialSettlementScheduleId"]},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"error updating completion date"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/workspaces/{workspace_id}/financial-approvals":{"post":{"tags":["Settlement"],"summary":"Approve or Unapprove Financial Settlement Schedule","description":"This endpoint is used by conveyancing law firms to approve the financial line items so the workspace can be prepared.","operationId":"approveFinancialSettlementSchedule","security":[{"oauth2":["x-api:approve:financial_settlement_schedules","x-api:unapprove:financial_settlement_schedules","edit:financial_settlement_schedules","view:financial_settlement_schedules","approve:financial_settlement_schedules","unapprove:financial_settlement_schedules"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","approvedBy"],"properties":{"action":{"type":"string","pattern":"^(APPROVE|UNAPPROVE)$","description":"Action to perform on financial settlement schedule <br> Allowed values: [`APPROVE`, `UNAPPROVE`]\n","example":"APPROVE"},"approvedBy":{"description":"Email address of the user who performed the approval action","type":"string","minLength":1,"pattern":"^$|(?:[A-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[A-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[A-z0-9](?:[A-z0-9-]*[A-z0-9])?\\.)+[A-z0-9](?:[A-z0-9-]*[A-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-z0-9-]*[A-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5A\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])","example":"approver@lawfirm.com"}}},"examples":{"approveRequest":{"summary":"Approve financial settlement schedule request","value":{"action":"APPROVE","approvedBy":"approver@lawfirm.com"}},"unapproveRequest":{"summary":"Unapprove financial settlement schedule request","value":{"action":"UNAPPROVE","approvedBy":"unapprover@lawfirm.com"}}}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Current status of the financial settlement schedule <br> values: [`APPROVED`, `PREPARED`]\n","example":"APPROVED"},"approvedBy":{"type":"string","format":"email","description":"Email address of the user who performed the approval action","example":"approver@lawfirm.com"},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","format":"uuid","description":"Unique identifier for the line item","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"amount":{"type":"number","description":"Amount for the line item","example":100},"type":{"type":"string","description":"Type of line item <br> values: [`SOURCE`, `DESTINATION`]\n","example":"SOURCE"},"authorised":{"type":"boolean","nullable":true,"description":"Authorization status of the line item","example":true},"reference":{"type":"string","description":"Reference for the line item","example":"ref"},"category":{"type":"string","description":"Category of the line item","example":"Mortgage Advance"}}},"description":"List of line items in the financial settlement schedule"}}},"examples":{"approvedResponse":{"summary":"Approved financial settlement schedule response","value":{"status":"APPROVED","approvedBy":"approver@lawfirm.com","lineItems":[{"lineItemId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","amount":100,"type":"SOURCE","authorised":true,"reference":"ref","category":"Mortgage Advance"},{"lineItemId":"4fa85f64-5717-4562-b3fc-2c963f66afa7","amount":50,"type":"DESTINATION","authorised":true,"reference":"destination ref","category":"Redemption"}]}},"unapprovedResponse":{"summary":"Unapproved financial settlement schedule response","value":{"status":"PREPARED","approvedBy":"unapprover@lawfirm.com","lineItems":[{"lineItemId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","amount":100,"type":"SOURCE","authorised":false,"reference":"ref","category":"Mortgage Advance"},{"lineItemId":"4fa85f64-5717-4562-b3fc-2c963f66afa7","amount":50,"type":"DESTINATION","authorised":false,"reference":"destination ref","category":"Redemption"}]}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"action","message":"action must be either APPROVE or UNAPPROVE"}]}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Resource not found for: workspace id"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/financial-settlement-schedule/{financialSettlementScheduleId}/line-items/{lineItemId}/accept-payee-account-details":{"post":{"tags":["Settlement"],"summary":"Accept Payee Account Details","description":"This API allows integrators to manually accept/override CoP (Confirmation of Payee) verification results for a destination line item.\n\nLine items with any of the following `partnerReasonCode` values are not supported and cannot be accepted/overridden:\n  - `AC01`: Incorrect account number\n  - `ANNM`: Account name does not match (full mismatch)\n  - `SCNS`: Sort code not supported\n  - `NO_BANKCODE_FOUND_FOR_SORTCODE` (Error 400)\n  - `NO_FPSEISCD_ENTRY_FOUND_FOR_SORTCODE` (Error 422)\n","operationId":"acceptPayeeAccountDetails","security":[{"oauth2":["x-api:accept:payee_account_details","edit:fss_line_items"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"financialSettlementScheduleId","in":"path","required":true,"description":"Unique identifier of the Financial Settlement Schedule","schema":{"type":"string","format":"uuid"}},{"name":"lineItemId","in":"path","required":true,"description":"Unique identifier of the Line Item","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"data":{"lineItemId":"c7c0ee40-25c1-11ec-9621-0242ac130002","type":"DESTINATION","amount":10000,"authorised":false,"reference":"Payment ref","category":"Redemption","lineItemReference":"PEXA220000003D01","bankAccount":{"sortCode":"123456","accountNumber":"12345678","accountName":"John Doe"},"verificationDetail":{"status":"NAME_PARTIAL_MATCH","verified":true,"isManualOverrideAllowed":true,"acceptedAt":"2026-05-08T10:30:00Z","acceptedBy":"INTEGRATOR:59a02f78-79c2-49ff-b27f-5606b4cda762","actualName":"J Doe"},"hasLinkedAccount":false},"errors":[]}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"lineItemId","message":"lineItemId is not in UUID format"}]}}}},"401":{"description":"UNAUTHORIZED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Unauthorized"}]}}}},"403":{"description":"FORBIDDEN","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Forbidden"}]}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Resource not found for: line item id"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"501":{"description":"NOT IMPLEMENTED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}}},"components":{"schemas":{"FinancialSettlementScheduleApprovalRequest":{"type":"object","required":["action","approvedBy"],"properties":{"action":{"type":"string","pattern":"^(APPROVE|UNAPPROVE)$","description":"Action to perform on financial settlement schedule <br> Allowed values: [`APPROVE`, `UNAPPROVE`]\n","example":"APPROVE"},"approvedBy":{"description":"Email address of the user who performed the approval action","type":"string","minLength":1,"pattern":"^$|(?:[A-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[A-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[A-z0-9](?:[A-z0-9-]*[A-z0-9])?\\.)+[A-z0-9](?:[A-z0-9-]*[A-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-z0-9-]*[A-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5A\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])","example":"approver@lawfirm.com"}}},"FinancialSettlementScheduleApprovalResponse":{"type":"object","properties":{"status":{"type":"string","description":"Current status of the financial settlement schedule <br> values: [`APPROVED`, `PREPARED`]\n","example":"APPROVED"},"approvedBy":{"type":"string","format":"email","description":"Email address of the user who performed the approval action","example":"approver@lawfirm.com"},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","format":"uuid","description":"Unique identifier for the line item","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"amount":{"type":"number","description":"Amount for the line item","example":100},"type":{"type":"string","description":"Type of line item <br> values: [`SOURCE`, `DESTINATION`]\n","example":"SOURCE"},"authorised":{"type":"boolean","nullable":true,"description":"Authorization status of the line item","example":true},"reference":{"type":"string","description":"Reference for the line item","example":"ref"},"category":{"type":"string","description":"Category of the line item","example":"Mortgage Advance"}}},"description":"List of line items in the financial settlement schedule"}}},"ApprovedLineItem":{"type":"object","properties":{"lineItemId":{"type":"string","format":"uuid","description":"Unique identifier for the line item","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"amount":{"type":"number","description":"Amount for the line item","example":100},"type":{"type":"string","description":"Type of line item <br> values: [`SOURCE`, `DESTINATION`]\n","example":"SOURCE"},"authorised":{"type":"boolean","nullable":true,"description":"Authorization status of the line item","example":true},"reference":{"type":"string","description":"Reference for the line item","example":"ref"},"category":{"type":"string","description":"Category of the line item","example":"Mortgage Advance"}}},"FundsAuthorisationRequest":{"type":"object","required":["completionDate","lineItem"],"properties":{"completionDate":{"type":"string","format":"date","example":"1970-12-31"},"lineItem":{"type":"object","required":["authorised","category","amount"],"properties":{"authorised":{"type":"boolean","example":true,"description":"Authorisation status of the line item"},"category":{"type":"string","pattern":"^(Mortgage Advance)$","description":"Allowed values:\n [`Mortgage Advance`]\n","example":"Mortgage Advance"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10}}}}},"FundsAuthorisationResponse":{"type":"object","properties":{"matched":{"type":"boolean","example":true},"authorised":{"type":"boolean","example":true,"description":"Authorisation status of the line item"}}},"LineItem":{"type":"object","required":["authorised","category","amount"],"properties":{"authorised":{"type":"boolean","example":true,"description":"Authorisation status of the line item"},"category":{"type":"string","pattern":"^(Mortgage Advance)$","description":"Allowed values:\n [`Mortgage Advance`]\n","example":"Mortgage Advance"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10}}},"Authorised":{"type":"boolean","example":true,"description":"Authorisation status of the line item"},"CreateLineItemRequest":{"type":"object","properties":{"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"hasLinkedAccount":{"type":"boolean","description":"Flag to indicate whether account is linked to a financial account"}},"required":["type","amount","reference","category"]},"FinancialSettlementScheduleListResponse":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"financialSettlementScheduleId":{"type":"string","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ab130002"},"workspaceId":{"type":"string","description":"UUID of the corresponding workspace","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"workspaceStatus":{"type":"string","description":"Status of workspace to which the financial settlement schedule belongs","example":"PREPARED"},"completionDate":{"type":"string","description":"settlement completion date, yyyy-mm-dd (format)","format":"date"},"approvals":{"default":[],"type":"array","items":{"type":"object","properties":{"participantId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"isApproved":{"type":"boolean","example":true}}},"example":[{"participantId":"59a02f78-79c2-49ff-b27f-5606b4cda762","isApproved":true}]},"status":{"type":"string","description":"financial settlement schedule status","example":"Prepared"},"workspaceReferenceId":{"type":"string","description":"Reference Id of the corresponding workspace","example":"PEXA220000001"},"hardLocked":{"type":"boolean","description":"Hard locked status of the workspace","example":false},"held":{"type":"boolean","description":"Held status of financial settlement schedule","example":false},"settlementReference":{"type":"string","description":"Reference of the associated settlement","example":"PEXA081220211105"},"slotTime":{"type":"string","description":"slot time at which financial settlement schedule will settle","example":880},"amountPayableOnCompletion":{"type":"number","description":"Amount payable to the seller representative on completion in S&P transaction","example":100},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"example":[{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false}]},"participants":{"default":[],"type":"array","items":{"type":"object","properties":{"subscriberId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"role":{"type":"string","example":"INCOMING_LENDER"}}}}},"required":["financialSettlementScheduleId"]}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"FinancialSettlementScheduleResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"financialSettlementScheduleId":{"type":"string","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ab130002"},"workspaceId":{"type":"string","description":"UUID of the corresponding workspace","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"workspaceStatus":{"type":"string","description":"Status of workspace to which the financial settlement schedule belongs","example":"PREPARED"},"completionDate":{"type":"string","description":"settlement completion date, yyyy-mm-dd (format)","format":"date"},"approvals":{"default":[],"type":"array","items":{"type":"object","properties":{"participantId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"isApproved":{"type":"boolean","example":true}}},"example":[{"participantId":"59a02f78-79c2-49ff-b27f-5606b4cda762","isApproved":true}]},"status":{"type":"string","description":"financial settlement schedule status","example":"Prepared"},"workspaceReferenceId":{"type":"string","description":"Reference Id of the corresponding workspace","example":"PEXA220000001"},"hardLocked":{"type":"boolean","description":"Hard locked status of the workspace","example":false},"held":{"type":"boolean","description":"Held status of financial settlement schedule","example":false},"settlementReference":{"type":"string","description":"Reference of the associated settlement","example":"PEXA081220211105"},"slotTime":{"type":"string","description":"slot time at which financial settlement schedule will settle","example":880},"amountPayableOnCompletion":{"type":"number","description":"Amount payable to the seller representative on completion in S&P transaction","example":100},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"example":[{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false}]},"participants":{"default":[],"type":"array","items":{"type":"object","properties":{"subscriberId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"role":{"type":"string","example":"INCOMING_LENDER"}}}}},"required":["financialSettlementScheduleId"]},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"FinancialSettlementScheduleDto":{"type":"object","properties":{"financialSettlementScheduleId":{"type":"string","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ab130002"},"workspaceId":{"type":"string","description":"UUID of the corresponding workspace","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"workspaceStatus":{"type":"string","description":"Status of workspace to which the financial settlement schedule belongs","example":"PREPARED"},"completionDate":{"type":"string","description":"settlement completion date, yyyy-mm-dd (format)","format":"date"},"approvals":{"default":[],"type":"array","items":{"type":"object","properties":{"participantId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"isApproved":{"type":"boolean","example":true}}},"example":[{"participantId":"59a02f78-79c2-49ff-b27f-5606b4cda762","isApproved":true}]},"status":{"type":"string","description":"financial settlement schedule status","example":"Prepared"},"workspaceReferenceId":{"type":"string","description":"Reference Id of the corresponding workspace","example":"PEXA220000001"},"hardLocked":{"type":"boolean","description":"Hard locked status of the workspace","example":false},"held":{"type":"boolean","description":"Held status of financial settlement schedule","example":false},"settlementReference":{"type":"string","description":"Reference of the associated settlement","example":"PEXA081220211105"},"slotTime":{"type":"string","description":"slot time at which financial settlement schedule will settle","example":880},"amountPayableOnCompletion":{"type":"number","description":"Amount payable to the seller representative on completion in S&P transaction","example":100},"lineItems":{"type":"array","default":[],"items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"example":[{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false}]},"participants":{"default":[],"type":"array","items":{"type":"object","properties":{"subscriberId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"role":{"type":"string","example":"INCOMING_LENDER"}}}}},"required":["financialSettlementScheduleId"]},"Approval":{"type":"object","properties":{"participantId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"isApproved":{"type":"boolean","example":true}}},"UpdateCompletionDateRequest":{"type":"object","properties":{"completionDate":{"type":"string","format":"date","example":"1970-12-31"}},"required":["completionDate"]},"UpdateLineItemRequest":{"type":"object","properties":{"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"}}},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"}}},"UpdateBankAccountDto":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"}}},"X-Request-Correlation-Id":{"type":"string","description":"The unique identifier for the request"},"PrimaryKeyId":{"type":"string","format":"uuid"},"Amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"X-API-Version":{"type":"string","description":"The API version that was used to process the request."},"Error":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}},"ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"LineItemType":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"Reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"AccountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"AccountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"BankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"AccountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"DisplayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"},"BankAccountDto":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"schemas-Authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"AccountVerificationStatus":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"AccountVerificationDetailDto":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"LineItemDto":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"LineItemResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"lineItemId":{"type":"string","description":"UUID of the corresponding line item","format":"uuid","example":"c7c0ee40-25c1-11ec-9621-0242ac130002"},"type":{"type":"string","pattern":"^(SOURCE|DESTINATION)$","example":"SOURCE","description":"Allowed values:\n [`SOURCE`, `DESTINATION`]\n"},"amount":{"type":"number","minimum":1,"maximum":999999999999.99,"description":"Amount to be credited / debited","example":10},"authorised":{"type":"boolean","example":true,"nullable":true,"description":"Authorisation status of the line item"},"reference":{"type":"string","minLength":1,"maxLength":18,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Nation wide"},"category":{"type":"string","description":"Allowed values for source line item:\n [`Mortgage Advance`]\n<br> Allowed values for destination line item:\n [`Redemption`, `Conveyancing Fees`, `Surplus`, `Onward Funds`]\n"},"lineItemReference":{"type":"string","example":"PEXA220000003D01"},"bankAccount":{"type":"object","nullable":true,"description":"This field is required and can be updated only for type DESTINATION.","properties":{"accountName":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[a-zA-Z0-9\\/\\-\\\\?:().,'#=!\"%&*<>;@{+\\s]*$","example":"Bob Smith"},"accountNumber":{"type":"string","pattern":"^\\d{8}$","example":"12345678"},"bankCode":{"type":"string","pattern":"^\\d{6}$","example":"123456"},"accountType":{"type":"string","pattern":"^(BUSINESS|PERSONAL)$","example":"BUSINESS","description":"Allowed Values: [`BUSINESS`, `PERSONAL`]\n"},"displayName":{"type":"string","nullable":true,"maxLength":35,"pattern":"^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$","example":"Mortgage account"}},"required":["accountName","accountNumber","bankCode"]},"verificationDetail":{"type":"object","nullable":true,"properties":{"status":{"type":"string","pattern":"^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$","example":"NAME_PARTIAL_MATCH","description":"status of account verification Allowed Values: [ `MATCH`, `NAME_PARTIAL_MATCH`, `NAME_PARTIAL_MATCH_TYPE_NO_MATCH`, `NO_MATCH`, `UNABLE_TO_MATCH`, `ERROR`, `TIMEOUT`, `TYPE_NO_MATCH`, `ACCOUNT_VERIFICATION_NOT_RUN` ]\n"},"partnerReasonCode":{"type":"string","nullable":true,"description":"Reason code sent from third party system for account verification.\n\n| Code |                Description                   |\n| -------|----------------------------------|\n| ANNM | Account Name does Not Match |\n| MBAM | There may be a match on the Account name |\n| BANM | Business account, name matches |\n| PANM | Personal account, name matches |\n| BAMM | Business account, name may be a match |\n| PAMM | Personal account, name may be a match |\n| AC01 | Incorrect Account Number |\n| IVCR | Invalid Customer Reference |\n| ACNS | Account type Not Supported for CoP |\n| OPTO | Opted out of CoP Scheme |\n| CASS | Account has been switched |\n| SCNS | Sort code not supported at endpoint |\n"},"verified":{"type":"boolean","description":"denotes in the account details are verified"},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"timestamp recorded when the consent was given for the account"},"acceptedBy":{"type":"string","nullable":true,"description":"id of the user who gave the consent for the account"},"actualName":{"type":"string","nullable":true,"description":"Actual name of given account received from CoP in case of partial match"},"isManualOverrideAllowed":{"type":"boolean","description":"Flag to indicate if manual override is allowed"}}},"hasLinkedAccount":{"type":"boolean","nullable":true,"description":"Flag to indicate whether account is a linked account"}}},"errors":{"default":[],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"FinancialSettlementScheduleParticipant":{"type":"object","properties":{"subscriberId":{"type":"string","format":"uuid","example":"59a02f78-79c2-49ff-b27f-5606b4cda762"},"role":{"type":"string","example":"INCOMING_LENDER"}}},"Email":{"type":"string","minLength":1,"pattern":"^$|(?:[A-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[A-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[A-z0-9](?:[A-z0-9-]*[A-z0-9])?\\.)+[A-z0-9](?:[A-z0-9-]*[A-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-z0-9-]*[A-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5A\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])","example":"approver@lawfirm.com"}},"examples":{"FinancialSettlementScheduleApprovalRequest":{"summary":"Approve financial settlement schedule request","value":{"action":"APPROVE","approvedBy":"approver@lawfirm.com"}},"FinancialSettlementScheduleUnapprovalRequest":{"summary":"Unapprove financial settlement schedule request","value":{"action":"UNAPPROVE","approvedBy":"unapprover@lawfirm.com"}},"FinancialSettlementScheduleApprovedResponse":{"summary":"Approved financial settlement schedule response","value":{"status":"APPROVED","approvedBy":"approver@lawfirm.com","lineItems":[{"lineItemId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","amount":100,"type":"SOURCE","authorised":true,"reference":"ref","category":"Mortgage Advance"},{"lineItemId":"4fa85f64-5717-4562-b3fc-2c963f66afa7","amount":50,"type":"DESTINATION","authorised":true,"reference":"destination ref","category":"Redemption"}]}},"FinancialSettlementScheduleUnapprovedResponse":{"summary":"Unapproved financial settlement schedule response","value":{"status":"PREPARED","approvedBy":"unapprover@lawfirm.com","lineItems":[{"lineItemId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","amount":100,"type":"SOURCE","authorised":false,"reference":"ref","category":"Mortgage Advance"},{"lineItemId":"4fa85f64-5717-4562-b3fc-2c963f66afa7","amount":50,"type":"DESTINATION","authorised":false,"reference":"destination ref","category":"Redemption"}]}},"CreateSourceLineItem":{"value":{"type":"SOURCE","amount":100,"reference":"test reference","category":"Mortgage Advance"}},"CreateDestinationLineItem":{"value":{"amount":100,"type":"DESTINATION","reference":"test reference","category":"Redemption","bankAccount":{"accountName":"xyz account","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"hasLinkedAccount":false}},"SourceLineItem":{"value":{"data":{"lineItemId":"5c39f824-4070-46fc-97c0-72c565542e09","type":"SOURCE","amount":19,"authorised":false,"reference":"dfd","category":"Mortgage Advance","lineItemReference":"PEXA230044822S01","bankAccount":null,"verificationDetail":null,"hasLinkedAccount":null},"errors":[]}},"DestinationLineItem":{"value":{"data":{"lineItemId":"ed781522-e4df-4a11-936c-6b5ec0ec9498","amount":56,"type":"DESTINATION","authorised":null,"reference":"hdg","category":"Redemption","lineItemReference":"PEXA230044822D02","bankAccount":{"accountName":"acc name","accountNumber":"34235648","bankCode":"453673","accountType":"BUSINESS","displayName":null},"verificationDetail":{"status":"MATCH","partnerReasonCode":null,"verified":true,"acceptedAt":null,"acceptedBy":null,"actualName":null,"isManualOverrideAllowed":false},"hasLinkedAccount":false},"errors":[]}},"DestinationLineItemWithLinkedAccount":{"value":{"data":{"lineItemId":"85f301f6-11d2-4fc2-bd7f-17af37df1192","amount":10,"type":"DESTINATION","authorised":null,"reference":"hh","category":"Redemption","lineItemReference":"PEXA230044822D01","bankAccount":{"accountName":"ReportsUpdates","accountNumber":"52352322","bankCode":"543253","accountType":"BUSINESS","displayName":"API394"},"verificationDetail":null,"hasLinkedAccount":true},"errors":[]}},"CreateLineItemTypeError":{"value":{"error":{"field":"type","message":"type must be one of [SOURCE, DESTINATION]"}}},"BankAccountMissingError":{"value":{"error":{"field":"bankAccount","message":"field is missing"}}},"AddLineItemDefault400ErrorMessage":{"value":{"error":{"field":"amount","message":"field is missing"}}},"UpdateBankAccountDetails":{"value":{"bankAccount":{"accountName":"accountA","accountNumber":"12345678","bankCode":"123456"}}},"UpdateAmount":{"value":{"amount":123456}},"UpdateReference":{"value":{"reference":"sample"}},"UpdateBankAccountError":{"value":{"errors":[{"field":"accountNumber","message":"account number is not in valid format"}]}},"UpdateAmountError":{"value":{"errors":[{"field":"amount","message":"amount cannot be empty"}]}},"UpdateReferenceError":{"value":{"errors":[{"field":"reference","message":"invalid reference"}]}},"UpdateLineItem500StatusDefaultError":{"value":{"errors":[{"message":"Internal server error"}]}},"UpdateFssSuccess":{"value":{"data":{"lineItemId":"c7c0ee40-25c1-11ec-9621-0242ac130002","type":"DESTINATION","amount":100,"authorised":true,"reference":"Nation wide","category":"Settlement","lineItemReference":"PEXA220000003D01","bankAccount":{"accountName":"accountA","accountNumber":"12345678","bankCode":"123456","accountType":"BUSINESS","displayName":"Mortgage account"},"verificationDetail":{"status":"MATCH","verified":true,"acceptedAt":"2022-01-01T00:00:00Z","acceptedBy":"c7c0ee40-25c1-11ec-9621-0242ac130002","actualName":"accountA","isManualOverrideAllowed":false},"hasLinkedAccount":true},"errors":[]}},"InternalServerErrorMessage":{"value":{"errors":[{"message":"Internal Server Error"}]}}},"responses":{"Unauthorized":{"description":"UNAUTHORISED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"WWW-Authenticate":{"schema":{"type":"string"},"description":"Contains token level error description (Ex - Token Expired, Invalid Audience)"}}},"ServiceUnavailable":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://login.pexauk.co.uk/oauth/token","scopes":{"x-api:accept:payee_account_details":"Permission to accept payee account details (CoP override)","x-api:authorise:funds":"Permission to authorise funds for a workspace","x-api:approve:financial_settlement_schedules":"Permission to approve financial settlement schedules","x-api:unapprove:financial_settlement_schedules":"Permission to unapprove financial settlement schedules","add:fss_line_items":"Permission to add financial settlement schedule line items","delete:fss_line_items":"Permission to delete financial settlement schedule line items","view:financial_settlement_schedules":"Permission to view financial settlement schedules","edit:financial_settlement_schedules":"Permission to edit financial settlement schedules","edit:fss_line_items":"Permission to edit financial settlement schedule line items","authorise:funds":"Permission to authorise funds for a workspace","approve:financial_settlement_schedules":"Permission to approve financial settlement schedules","unapprove:financial_settlement_schedules":"Permission to unapprove financial settlement schedules"}}}}},"parameters":{"X-Request-Correlation-Id":{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},"WorkspaceId":{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}}},"x-audience-url":"https://app.pexauk.co.uk/api/v1/pexa-partner"}
```