Search
K
financials v1

Accept Payee Account Details

This API allows integrators to manually accept/override CoP (Confirmation of Payee) verification results for a destination line item.

Line items with any of the following partnerReasonCode values are not supported and cannot be accepted/overridden:

  • AC01: Incorrect account number
  • ANNM: Account name does not match (full mismatch)
  • SCNS: Sort code not supported
  • NO_BANKCODE_FOUND_FOR_SORTCODE (Error 400)
  • NO_FPSEISCD_ENTRY_FOUND_FOR_SORTCODE (Error 422)
post
https://api.pexa.co.uk/partner/api/platformconnect/v1/financial-settlement-schedule/{financialSettlementScheduleId}/line-items/{lineItemId}/accept-payee-account-details

Path Parameters

financialSettlementScheduleIdstring(uuid)required

Unique identifier of the Financial Settlement Schedule

lineItemIdstring(uuid)required

Unique identifier of the Line Item

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Response

application/json

OK

dataobject
Show Child Parameters
errorsarray[object]

Default:[]

Show Child Parameters
post/partner/api/platformconnect/v1/financial-settlement-schedule/{financialSettlementScheduleId}/line-items/{lineItemId}/accept-payee-account-details
 
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

Update Financial Line Item

This API is used in conjunction with ‘Fetch financial settlement schedules’ API to update data in an existing line item

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

Path Parameters

financialSettlementScheduleIdstring(uuid)required

Financial Settlement Schedule id for which lineItems are updated

lineItemIdstring(uuid)required

Line Item Id for which update has to happen

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
bankAccountobject | null

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

Show Child Parameters
amountnumber

Amount to be credited / debited

>= 1<= 999999999999.99

Example:10

referencestring

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

>= 1 characters<= 18 characters

Example:Nation wide

Response

application/json

OK

dataobject
Show Child Parameters
errorsarray[object]

Default:[]

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

Body

{ "bankAccount": { "accountName": "accountA", "accountNumber": "12345678", "bankCode": "123456" } }
 
application/json

Delete Financial Line Item

This API is used to delete the existing source and destination line item

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

Path Parameters

financialSettlementScheduleIdstring(uuid)required

Financial Settlement Schedule id for which lineItem need to be deleted

lineItemIdstring(uuid)required

Line Item Id for which delete need to happen

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Response

NO_CONTENT

delete/partner/api/platformconnect/v1/financial-settlement-schedules/{financialSettlementScheduleId}/line-items/{lineItemId}
 

Get Financial Settlement Schedule

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.

The 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.

get
https://api.pexa.co.uk/partner/api/platformconnect/v1/financial-settlement-schedules

Query Parameters

workspace_idstring(uuid)

Unique identifier of the Workspace entity for which financial settlement schedule need to be fetched

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Response

application/json

OK

recordsarray[object]
Show Child Parameters
errorsarray[object]

Default:[]

Show Child Parameters
get/partner/api/platformconnect/v1/financial-settlement-schedules
 
application/json