API Suite - July 2024 Release Notes Summary

The July release contains some new fields to existing APIs and various bug fixes.

Instruction ID added to Confirmations endpoint

The payment gateway instruction ID that is sent with the payment is now included in the Get Confirmations Status by payment ID endpoint. This field can be used in lieu of a UETR for non-SWIFT payments to assist in tracking. Note: not all payee banks will receive this ID and is dependent on the banks used in processing.


Fields excluded from SWIFT character validation

The following fields will be excluded from the SWIFT character validation that will be live in the September 2024 release:

  • thirdPartyRemitter.email
  • payments.remittanceData
  • remittanceData.ref

Settlement webhook changes

We've made some changes to the way settlement event webhooks and Settlement Resource endpoints work:

  • Settlement events will be triggered for all committed, unfunded orders in the last 30 days. After 30 days, event monitoring will stop.
  • All funding activity for orders within this window will generate an event for consumption including amount received and amount left due for partially funded orders

Various bug fixes

  • Fixed an issue with third-party remitter ID length validation
  • Improved sanction scanning times