Open Banking (Onboarding)

The Nium PSD2 Open Banking API is the mechanism for third-party providers to interact with Nium customers and products based in Europe.

The Open Banking API will be useful for a regulated Third Party Provider (TPP) who wants to get account details for Nium customers in Europe.

Account Information Service (AIS) Flow

As part of Nium PSD2 Open Banking AIS flow, Nium provides APIs for fetching consolidated customer account information, based on authorization and customer consent.

Nium One Clients needs to integrate with Nium ecosystem for Open Banking AIS as described below.

Step 1: Client AIS Redirect URL

Nium will store the consent Id and send details of customer identification and reference number on a pre-configured Client AIS Redirect URL to Client. The Client Redirect URL needs to be provided by Nium One Clients during the set-up of the Client Program. Nium One Clients need to implement its own authentication mechanism to authenticate AIS requests received.

Step 2: Consent Detail

Client to authenticate the customer, fetch the consent details by calling Nium Consent Detail API, and display on the authorization page.

Query Parameter

FieldDescription
idThe account consent Id of the customer to fetch this data.

Step 3: Update Customer Consent Status

To update customer’s response against the consent Id by calling the Nium Update Consent Status API. Nium will update the consent of customer as received. This step can be used later to update consent status if the customer revokes the consent.

GET https://apisandbox.spend.nium.com/api/v1/consent/{accountConsentId}?status={consentStatus}

Path Parameter

FieldDescription
accountConsentIdThe account consent Id for which status needs to be updated.

Query Parameter

FieldDescription
statusThe status of customer consent. It may be AUTHORIZED when the customer has provided consent. Otherwise, it may be updated to REJECTED at Nium if the customer has revoked consent or opted-out.

The AIS flow is now complete and the TPP can redirect the customer and display the details accordingly.

The below diagram shows the AIS flow:

[need diagram]

Payment Initiation Service (PIS) Flow

As a part of Nium PSD2 Open Banking PIS flow, Nium provides APIs for initiating payout based on whether the Strong Customer Authentication (SCA) is required or not.

Nium One clients needs to integrate with Nium ecosystem for Open Banking PIS as described below.

When a payout transaction is initiated, internal validations are run and it is also checked if Strong Customer Authentication (SCA) is required.

In case there is an internal validation failure, the transaction status becomes REJECTED.

Step 1: Client Redirect to Auth Page URL

In cases where Strong Customer Authentication (SCA) is required, NIUM will redirect the customer to a pre-configured URL provided by Client for authentication. The Client Redirect URL needs to be provided by BaaS Clients during the set-up of the Client Program. BaaS Clients need to implement its own SCA authentication mechanism to authenticate PIS requests received.** **

GET https://<ClientUrl>?authType=PAYMENT&customerHashId={customerHashId}&referenceNumber={systemReferenceNumber}

Path Parameter

Fields Description
customerHashId This parameter contains the unique NIUM customer identifier [UUID].
referenceNumber This parameter contains the unique NIUM transaction authorization reference [UUID] called as systemReferenceNumber at NIUM.

Step #2: Fetch Payment Details

Client to authenticate the customer, fetch the payment details by calling NIUM Payment Detail API, and display on the authorization page.

This API allows Client to fetch payment details using system reference number of the transaction, as part of the Open Banking PIS flow and based on customer's consent.

GET https://apisandbox.spend.nium.com/api/v1/payment/{systemReferenceNumber}/detail

Now the Client will continue with an authorization which may succeed or fail. In both cases, the Client shall trigger the NIUM API to update the status of authorization.

Step #3: Update Authorization Status

GET https://apisandbox.spend.nium.com/api/v1/payment/{systemReferenceNumber}?status={status}

Query parameter

| Fields Description
status
This query parameter can accept two values which is APPROVED and REJECTED.

If the received status is APPROVED, transaction status is INITIATED. It then goes through the remittance lifecycle.

If the received status is REJECTED, transaction status is REJECTED.

This transaction is captured in the system with transaction type as transfer_local.

The below diagram shows the PIS flow:

Open Banking APIs

There are two additional APIs in this flow as described in subsequent subsections:

Account Details By Customer Consent ID
Payment Details by System Reference Number
Next to read:
Account Details By Customer Consent ID
On This Page
Open Banking
Account Information Service (AIS) Flow
Payment Initiation Service(PIS) Flow