PPS ORIAN API

Endpoints

An ORIAN Endpoint consists of a primary and optionally a secondary URL. The ORIAN delegated authorisation and notification systems send either delegated authorisation requests or notifications to the Endpoint URL.

Fail-over to the Secondary Endpoint

ORIAN allows the definition of a secondary URL for each endpoint to be used in case the primary URL is not contactable.

Failover will occur when a configured threshold of failed requests to the primary URL has been reached.

• The secondary endpoint must be configured in production
• Swapping back to the primary (if the secondary is still responsive) must be done manually by PPS

Endpoint URL Definition

• All ORIAN communication is secured by HTTPS to ensure the encryption of ORIAN data in transit.
• HTTP endpoints are not supported.
• Additionally PPS require that all endpoints support TLS 1.2 as a minimum.
• Self-signed TLS certificates are not supported
• Endpoint URL's can include a port

The ORIAN system appends the version, the transaction / direct debit mandate resource, and the transaction / direct debit mandate identifier to the URL specified in the endpoint definition.

Examples for a transaction / direct debit mandate with identifier of 12345

Multiple Endpoints

• Delegated Authorisation support multiple endpoint definitions (each endpoint can still have its own secondary URL).
• Multiple Endpoints are supported for ORIAN Notifications (each endpoint can still have its own secondary URL).

When multiple endpoints are configured for notifications then the notification is only considered as successfully delivered when the ORIAN Notification system receives a successful 200 acknowledgement from every configured endpoint.

If one of the endpoints responds with failure (or time out) then the re-delivery process will be activated. Note on the next re-delivery attempt the notification will again be sent every endpoint (i.e. endpoints may receive a notification multiple times).

Concurrent Notifications

During periods of high activity at PPS (for example during batch processing) then multiple con-current notifications may be received at the configured endpoint(s). The endpoints must be able to cope with simultaneous notifications. Currently by default the maximum number of concurrent notifications that may be sent by the ORIAN notification system is 15.

Summary Of ORIAN Configuration

The following information is required in order to enable ORIAN delegated authorisation and / or ORIAN notifications

Delegated Authorisation

• Product Class
• Endpoint Definition
  • Primary URL
  • Secondary Endpoint URL (if required)
  • Endpoint security token
  • Endpoint fail over strategy (Manual, Auto On Failure Count)
• Balance Management Option (Manual, Auto On Failure Count)

Note: The same endpoint URL's can be used for both delegated authorisation and notifications and across product classes

Notifications

• Product Class
• Subscription (Transaction notification only - Authorisation, Declined, Financial, Non-Financial)
• Endpoint
  • Primary URL
  • Secondary Endpoint URL (if required)
  • Endpoint security token
  • Endpoint fail over strategy (Manual, Auto On Failure Count)
  • Notification Filtering by scheme and / or transaction type
• Multiple Endpoints (if required)

Note: The same endpoint URL's can be used for both delegated authorisation and notifications and across product classes