Updates
2022
-
July 2022 release
This Payments Out Service release contains changes to the Provider and Provider Messaging APIs.
-
What's Next Release
This Payments Out Service release contains changes to the Provider and Provider Messaging APIs.
-
June 2022 release
This Payments Out Service release contains changes to the Provider and Provider Messaging APIs.
Changes to Provider API
- Retrieve a subscription
New endpoint/api-provider-v1/subscriptions/{subscriptionId}to retrieve the data for a subscription.
- Retrieve a subscription
-
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 fielddata.payments.paymentCompletedDateto update when a payment has completed.
- Update a batch of payments
-
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/notificationsto send update notifications to the consumer.
- Send an update notification
-
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 valueCreditorPutfordata.accountType.validationRules.validation.apiPathavailable for updating creditor information. -
Update a batch of payments
New non-mandatorydata.additionalDataanddata.payments.additionalDataobject added, accepting only values of typeStringornull.
-
2021
-
November 2021 release
This Payments Out Service release contains changes to the Provider and Provider Messaging APIs.
-
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
NewdefaultLanguageandsupportedLanguagesobjects return the default language and the languages the provider supports.
Changes to Provider Messaging API
-
Create responses to creditor queries
addressLine1,addressLine2andaddressLine3withindata.creditor.postalAddressnow support up to 100 characters andcountrySubdivisionnow supports up to 50 characters. -
Create responses to debtor account queries
data.debtorobject now allowstaxIdto be set.dataobject now allowslegalEntityto be set.
Changes to Provider Webhooks API
- Send a notification to a payment provider when an event of interest occurs.
addressLine1,addressLine2andaddressLine3withinmessage.data.creditor.postalAddressnow support up to 100 characters andcountrySubdivisionnow supports up to 50 characters.
- Retrieve a payment provider
-
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
issuedAtandexpiresAtobjects which show when theauthoriselink was issued and when it expires, have been renamedauthoriseIssuedAtandauthoriseExpiresAt.
Changes to Provider Messaging API
-
Update a creditor (e.g. a supplier, employee or other payee)
issuedAtandexpiresAtobjects which show when theauthoriselink was issued and when it expires, have been renamedauthoriseIssuedAtandauthoriseExpiresAt. -
Update the details of a debtor account (i.e. a payment account to make or fund payments from)
issuedAtandexpiresAtobjects which show when theauthoriselink was issued and when it expires, have been renamedauthoriseIssuedAtandauthoriseExpiresAt.
Other Changes
Throughout, minimum input validation has been updated to prevent
"character. - Retrieve a batch of payments
-
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.defaultStatusnow allows statusProcessingto be set on a payment batch. -
Retrieve a batch of payments
Both now returnissuedAtandexpiresAtobjects in their responses, to show when theauthoriselink was issued and when it expires.
Changes to Provider Messaging API
-
Update a creditor (e.g. a supplier, employee or other payee)
linksnow allowsissuedAtandexpiresAtvalues to be set. -
Update the details of an debtor account (i.e. a payment account to make or fund payments from))
linksnow allowsissuedAtandexpiresAtvalues to be set. -
Create responses to debtor account queries
data.debtorobject now containsremittanceEmail, for a provider to notify a creditor that a payment has been made. -
Create responses to creditor queries
New non-mandatorydata.creditor.creditorTypeobject added, accepting only values ofNone,IndividualorOrganisation.
-