Search
K
financials v1

Financial

v1OAS 3.0

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.

API Base URL
  • Server 1:https://api.pexa.co.uk

    API Gateway URL

Security
oauth2 (oauth2)

Client Credentials OAuth Flow

Token URL: https://login.pexauk.co.uk/oauth/token

Scopes:

  • 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

Funds Authorisation

This API is used to authorise/un-authorise the fss source line item for a workspace

post
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}/funds-authorisation

Path Parameters

workspace_idstring(uuid)required

Workspace id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
completionDatestring(date)required

Example:1970-12-31

lineItemobjectrequired
Show Child Parameters

Response

application/json

OK

matchedboolean

Example:true

authorisedboolean

Authorisation status of the line item

Example:true

post/partner/api/platformconnect/v1/workspaces/{workspace_id}/funds-authorisation

Body

{ "completionDate": "1970-12-31", "lineItem": { "authorised": true, "category": "Mortgage Advance", "amount": 10 } }
 
application/json

Add Financial Line Item

This API is used in conjunction with ‘Fetch financial settlement schedules’ API to create an individual funds source or destination line item

post
https://api.pexa.co.uk/partner/api/platformconnect/v1/financial-settlement-schedules/{financialSettlementScheduleId}/line-items

Path Parameters

financialSettlementScheduleIdstring(uuid)required

Financial Settlement Schedule id for which lineItems are created

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
typestringrequired

Allowed values:
[SOURCE, DESTINATION]

Match pattern:^(SOURCE|DESTINATION)$

Example:SOURCE

categorystringrequired

Allowed values for source line item:
[Mortgage Advance]

Allowed values for destination line item:
[Redemption, Conveyancing Fees, Surplus, Onward Funds]

amountnumberrequired

Amount to be credited / debited

>= 1<= 999999999999.99

Example:10

referencestringrequired

Match pattern:^[a-zA-Z0-9\/\-\\?:().,'#=!"%&*<>;@{+\s]*$

>= 1 characters<= 18 characters

Example:Nation wide

bankAccountobject | null

This field is required and can be updated only for type DESTINATION.

Show Child Parameters
hasLinkedAccountboolean

Flag to indicate whether account is linked to a financial account

Response

application/json

OK

dataobject
Show Child Parameters
errorsarray[object]

Default:[]

Show Child Parameters
post/partner/api/platformconnect/v1/financial-settlement-schedules/{financialSettlementScheduleId}/line-items

Body

{ "type": "SOURCE", "amount": 100, "reference": "test reference", "category": "Mortgage Advance" }
 
application/json