thorium / clearbank.net Goto Github PK

Upcoming removal of old payments API endpoints

Notification of upcoming change

Friday 17 February 2023

ClearBank has recently upgraded the API endpoints used for FPS and CHAPS payments from version 2 to version 3.

The old endpoints are now deprecated and will no longer be available from 17th February 2023. This email is your six months’ notice that you will need to migrate to the version 3 endpoints ahead of that date if you have not already done so. Our API Integration team will be in touch to discuss the next steps.

You will need to migrate:

• From POST /v2/Payments/FPS to POST /v3/Payments/FPS
• From POST /v2/Payments/CHAPS to POST /v3/Payments/CHAPS

The version 3 endpoints ensure the payer address is included when initiating an outbound payment in accordance with the Funds Transfer Regulations (FTR).

The key changes in the new endpoints are:

• Inclusion of Payer Address in the request
• Reduction of the maximum batch size to 100
• Removal of the RequestedExecutionDate field (previously marked obsolete in v2)

Full details are on the Payments section of the ClearBank Developer Portal.

New information in accounts API and deprecation notice

Enhancement completed

Tuesday 6 September 2022

ClearBank has upgraded the GET accounts endpoints to make it easier for you to confirm the status of an account, should you ever want to reconcile. The change is now live.

If you would like to access the new information, call version 3 of these endpoints:

• GET /v3/Accounts
• GET /v3/Accounts/{AccountId}

The response includes these new fields:

• Status – the status of the account, for example, Enabled, Suspended, or Closed
• StatusReason – indicates why the status was set
• MinimumBalance – the minimum allowable balance of the account

The response also contains all the fields that were present in version 2. Full details are available on the Developer Portal.

Please also note that version 2 of the GET /v2/Accounts and GET /v2/Accounts/{AccountId} endpoints are now deprecated and may be removed from 9th March 2023. Please ensure that you have migrated to the version 3 endpoints before this date.