Skip to content
Developerhome

Understand provider messaging and webhooks

  Less than to read

Provider messaging API

The Payments Out Service provider messaging API /api-provider-v1/ can:

  • send details of updates
  • respond to debtor and creditor queries
  • delete requests from consumers of Payments Out Service

This is done via a message to the consuming application using the subscription ID specified in the message.

The electronic payments provider uses the provider messaging API after processing a message from the consuming application.

All the endpoints in the provider messaging API are POSTs. They have the endpoint and message body describing the action you want to take. This is a messaging service rather than a direct endpoint, so the POST will return HTTP status code 202, with no response body.

The payload is forwarded to the consuming application. This is sent as a webhook to an endpoint configured in Payments Out Service for the consumer.

Operations available are:

  • POST debtoraccountputs – This informs the consuming application that a bank account has been created with the payment provider.
  • POST debtoraccountlistqueryresponses – This returns bank account details to the consuming application.
  • POST debtoraccountdeletes – This returns the status of a bank account delete request to the consuming application.
  • POST creditorputs – This informs the consuming application that a vendor has been created with the payment provider.
  • POST creditorlistqueryresponses – This returns vendor details to the consuming application.
  • POST creditordeletes – This returns the status of a vendor delete request to the consuming application.

Provider webhook notification API

For a Payments Out Service consuming application to send messages, the payments provider must implement the /notifications endpoint as defined in Provider Webhook Notifications API reference.

Raise a Payments Out Service ticket containing the URL the webhooks will be sent to.

When an event (such as a new vendor request is submitted by a consuming application) occurs in Payments Out Service, the provider receives a notification to this URL. This includes details of the event type and its related data.