Develop for Payments Out Service

2022

1. Thursday 5 May 2022

   May 2022 release

   This Payments Out Service release contains changes to the Provider and Provider Messaging APIs.

   ---

   Changes to Provider API

   • Update a batch of payments
     New field data.payments.paymentCompletedDate to update when a payment has completed.

2. Thursday 7 April 2022

   April 2022 release

   This Payments Out Service release contains changes to the Provider and Provider Messaging APIs.

   ---

   Changes to Provider Messaging API

   • Send an update notification
     New endpoint /api-provider-msg-v1/notifications to send update notifications to the consumer.

3. Friday 4 March 2022

   March 2022 release

   This Payments Out Service release contains changes to the Provider and Provider Messaging APIs.

   ---

   Changes to Provider API

   • Retrieve a payment provider
     New enumeration value CreditorPut for data.accountType.validationRules.validation.apiPath available for updating creditor information.

   • Update a batch of payments
     New non-mandatory data.additionalData and data.payments.additionalData object added, accepting only values of type String or null.

2021

4. Wednesday 10 November 2021

   November 2021 release

   This Payments Out Service release contains changes to the Provider and Provider Messaging APIs.

   ---

5. Thursday 16 September 2021

   September 2021 release

   This Payments Out Service release contains changes to the Provider and Provider Messaging APIs.

   ---

   Changes to Provider API

   • Retrieve a payment provider
     New defaultLanguage and supportedLanguages objects return the default language and the languages the provider supports.

   Changes to Provider Messaging API

   • Create responses to creditor queries
     addressLine1, addressLine2 and addressLine3 within data.creditor.postalAddress now support up to 100 characters and countrySubdivision now supports up to 50 characters.

   • Create responses to debtor account queries
     data.debtor object now allows taxId to be set. data object now allows legalEntity to be set.

   Changes to Provider Webhooks API

   • Send a notification to a payment provider when an event of interest occurs.
     addressLine1, addressLine2 and addressLine3 within message.data.creditor.postalAddress now support up to 100 characters and countrySubdivision now supports up to 50 characters.

6. Monday 26 July 2021

   July 2021 release B

   This Payments Out Service release contains changes to the Provider and Provider Messaging APIs.

   ---

   Changes to Provider API

   • Retrieve a batch of payments
     issuedAt and expiresAt objects which show when the authorise link was issued and when it expires, have been renamed authoriseIssuedAt and authoriseExpiresAt.

   Changes to Provider Messaging API

   • Update a creditor (e.g. a supplier, employee or other payee)
     issuedAt and expiresAt objects which show when the authorise link was issued and when it expires, have been renamed authoriseIssuedAt and authoriseExpiresAt.

   • Update the details of a debtor account (i.e. a payment account to make or fund payments from)
     issuedAt and expiresAt objects which show when the authorise link was issued and when it expires, have been renamed authoriseIssuedAt and authoriseExpiresAt.

   Other Changes

   Throughout, minimum input validation has been updated to prevent " character.

7. Thursday 8 July 2021

   July 2021 release A

   This Payments Out Service release contains changes to the Provider and Provider Messaging APIs.

   ---

   Changes to Provider API

   • Update a batch of payments
     data.defaultStatus now allows status Processing to be set on a payment batch.

   • Retrieve a batch of payments
     Both now return issuedAt and expiresAt objects in their responses, to show when the authorise link was issued and when it expires.

   Changes to Provider Messaging API

   • Update a creditor (e.g. a supplier, employee or other payee)
     links now allows issuedAt and expiresAt values to be set.

   • Update the details of an debtor account (i.e. a payment account to make or fund payments from))
     links now allows issuedAt and expiresAt values to be set.

   • Create responses to debtor account queries
     data.debtor object now contains remittanceEmail, for a provider to notify a creditor that a payment has been made.

   • Create responses to creditor queries
     New non-mandatory data.creditor.creditorType object added, accepting only values of None, Individual or Organisation.