Develop for Payments Out Service
Automate outgoing payments to suppliers and employees.
With the Payments Out Service APIs, you can create payment files and submit electronic payments.
Documentation
What is Payments Out Service?
Payments Out Service lets you create bank payment files and submit payments. Find out more.
Get started
Learn what you need to do to get started and integrate with Payments Out Service.
API reference
Explore our API reference and read the descriptions of resources exposed via our APIs.
Explore
Find out more about the API and its features.
Get set up
Find out if you meet the requirements and how to register.
Integrate
Learn about what you need to do to connect to and use our API.
Go live
Find out more about the go-live process and technical support.
What's new
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 fielddata.payments.paymentCompletedDate
to 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/notifications
to 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 valueCreditorPut
fordata.accountType.validationRules.validation.apiPath
available for updating creditor information. -
Update a batch of payments
New non-mandatorydata.additionalData
anddata.payments.additionalData
object added, accepting only values of typeString
ornull
.
-
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
NewdefaultLanguage
andsupportedLanguages
objects return the default language and the languages the provider supports.
Changes to Provider Messaging API
-
Create responses to creditor queries
addressLine1
,addressLine2
andaddressLine3
withindata.creditor.postalAddress
now support up to 100 characters andcountrySubdivision
now supports up to 50 characters. -
Create responses to debtor account queries
data.debtor
object now allowstaxId
to be set.data
object now allowslegalEntity
to be set.
Changes to Provider Webhooks API
- Send a notification to a payment provider when an event of interest occurs.
addressLine1
,addressLine2
andaddressLine3
withinmessage.data.creditor.postalAddress
now support up to 100 characters andcountrySubdivision
now 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
issuedAt
andexpiresAt
objects which show when theauthorise
link was issued and when it expires, have been renamedauthoriseIssuedAt
andauthoriseExpiresAt
.
Changes to Provider Messaging API
-
Update a creditor (e.g. a supplier, employee or other payee)
issuedAt
andexpiresAt
objects which show when theauthorise
link was issued and when it expires, have been renamedauthoriseIssuedAt
andauthoriseExpiresAt
. -
Update the details of a debtor account (i.e. a payment account to make or fund payments from)
issuedAt
andexpiresAt
objects which show when theauthorise
link was issued and when it expires, have been renamedauthoriseIssuedAt
andauthoriseExpiresAt
.
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.defaultStatus
now allows statusProcessing
to be set on a payment batch. -
Retrieve a batch of payments
Both now returnissuedAt
andexpiresAt
objects in their responses, to show when theauthorise
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 allowsissuedAt
andexpiresAt
values to be set. -
Update the details of an debtor account (i.e. a payment account to make or fund payments from))
links
now allowsissuedAt
andexpiresAt
values to be set. -
Create responses to debtor account queries
data.debtor
object now containsremittanceEmail
, for a provider to notify a creditor that a payment has been made. -
Create responses to creditor queries
New non-mandatorydata.creditor.creditorType
object added, accepting only values ofNone
,Individual
orOrganisation
.
-