PISP API Overview

[!CAUTION] This base URL MUST be updated to reflect the EU endpoint path

Base URL

The base URL for all PIS APIs is: https://rs1.production.ob.bankacredins.com/open-banking/v3.1/pisp/**

 

Supported Payment Services & Products

Credins Bank supports the following payment services and payment products based the Berlin Group POST /v1/{payment-service}/{payment-product} API specification:

Payment Service	Payment Product	Supported
payments		✔
bulk-payments		✔
inside-bank		✔
domestic		✔
cross-border		✔

 

The following Berlin Group Payment endpoints can also be called when the above payment service and payment product combination is supported by Credins Bank

Endpoint Name	Endpoint Call	Supported
Get Transaction Status Request	GET /v1/{payment-service}/{payment-product}/{paymentId}/status	✔
Get Payment Request	GET /v1/{payment-service}/{payment-product}/{paymentId}	✔

 

Payment Initiation Request

The mandatory X-Request-ID request header must be provided in each payment initiation request. This ID must be unique to the call as Credins Bank will use this ID as an idempotency key to recognise subsequent retries of the same payment initiation request.

If a duplicate X-Request-ID is received in a payment initiation request we will return the same result as the previous original request rather than initiating a further payment.

As the OAuth2 SCA Approach is supported by Credins Bank for payment initiation requests the following Request Headers should be provided in addition to the attributes flagged as mandatory by the Berlin Group:

• TPP-Redirect-URI: The URI of the TPP the PSU will be redirected back to after the successful execution of the PSU SCA
• TPP-Nok-Redirect-URI: If required, this will be the URI the PSU is redirected to when the PSU SCA fails or is cancelled by the PSU.

 

Payment Initiation Response

When the payment initiation request has been successfully validated, the response will return the scaOAuth link where the configuration of the OAuth2 Server is defined. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.

As part of each Payment initiation response returned, we will include an additional response header x-fapi-interaction-id. This response header will be in addition to the return of the mandatory X-Request-ID.

The X-Request-ID and x-fapi-interaction-id values should be provided when contacting us for any payment initiation support queries or issues.

 

Payment Options & Services Supported

The following options and services are supported by the Credins Bank during the end-to-end payment initiation process:

Payment Service Options	Supported
Payment Initiation with JSON encoding of the Payment Instruction	✔
Payment Initiation with pain.001 XML message as Payment Instruction	✖
TPP-Rejection-NoFunds-Preferred Request header	✔ ✖
Payment status notification (ASPSP-Notification-Support response header)	✖
Selection of Debtor account on Credins Bank pages	✔ ✖
Payment instruction at Multi-currency Aggregation level (“XXX”)	✔ ✖
Payment instruction at Multi-currency Sub-account level	✔ ✖
Funds Availability confirmation returned in Transaction Status	✔ ✖
Account ownerNames returned in Transaction Status response	✔ ✖
Account psuName returned in Transaction Status response	✔ ✖
Mandatory PSU authorisation on payment cancellation requests	✔ ✖

 

PSU Debtor Account Selection

For SEPA single and periodic payments Credins Bank will allow the PSU to select the debtor account the payment must be initiated from during the authentication flow when the account details have not been supplied by the TPP. This is as per Item 36 of the EBA Opinion of June 2020

 

Instructed Amount

The payment instructed amount will be subject to the PSU’s and Credins Bank payment transaction limits. These limits will be the same as the transaction limits applied within our online channels. Payment initiation requests that exceed the limit will be rejected.

 

Signing-baskets

At this time Credins Bank does not support the Berlin Group Signing-baskets and multi-level SCA for payment initiation requests.

 

Payment Initiation Requests for Periodic Payments

In addition to the Payment initiation request options, the following periodic payment initiation options are supported by Credins Bank:

Payment Execution Rule

The executionRule tag in the request body defines the behaviour when the recurring payment date falls on a weekend or bank holiday. The payment is then executed either on the “preceding” or “following” working date.

Execution Rule Option	Supported
following	✔ ✖
preceding	✔ ✖

 

Payment Frequency

The following periodic payment frequencies are supported:

Payment Frequency	Supported
Daily	✔ ✖
Weekly	✔ ✖
EveryTwoWeeks	✔ ✖
Monthly	✔ ✖
EveryTwoMonths	✔ ✖
Quarterly	✔ ✖
SemiAnnual	✔ ✖
Annual	✔ ✖
MonthlyVariable	✔ ✖

If a payment initiation request is received without a frequency or an unsupported frequency the request will be rejected.

 

Payment Initiation Requests for Bulk Payments

The bulk payment initiation request is an array of single payments, as offered by the ASPSP, preceded by generic payment information applicable to all individual payments contained.

The Payment Initiation API endpoint POST /v1/bulk-payments/{payment-product} is called by the TPP to start the payment process.

The value populated into the {payment-product} path parameter will depend on the payment products supported by the ASPSP.

Confirmation of the supported payment products is confirmed at the top of this page.

 

Debtor Account

• For Bulk payment initiation requests the debtor account details MUST be provided by the TPP and cannot be selected by the PSU as part of the authentication process.
• Only one single debtor account for all batch payments is supported

 

Batch Booking Preferred

The batchBookingPreferred field allows the PSU to confirm whether they prefer only one booking entry (field = true) or individual booking of all contained individual transactions (field = false).

As the contract agreed between the PSU and Credins Bank does / does not support this preference we will [DELETE ONE OPTION]:

• take into account the preferred batch booking requested by the PSU, or
• as per the PSU contract create one booking entry / create individual booking of all contained individual transactions

 

Execution Date / Time

DELETE OR UPDATE THE OPTIONS SUPPORTED

• As per the Berlin Group specification:

  • only one single execution date or datetime for all payments in the bulk request is supported and can be provided in the requestedExecutionDate or requestedExecutionTime
  • The requestedExecutionDate and requestedExecutionTime fields cannot be used in combination and only one of these optional fields can be included in the request.

• A future execution date for the bulk payments is supported and can be provided in the requestedExecutionDate field

• A future execution date for the bulk payments is not supported meaning all the payments will be initiated during the same day as the request.

• The requestedExecutionTime field is not supported.

• The requestedExecutionTime field is supported to allow you to request the date/time all the batch payments are initiated.

 

Payment Cancellation

At the current time the ability to cancel payments is not supported.

When available, Credins Bank the cancellation of payments will be supported when:

• the single or bulk payment initiation request is a future dated payment that has not been executed yet and there is sufficient time to cancel the payment instruction, or
• the payment initiation request relates to recurring periodic payments

When the payment initiation can be cancelled we will require the PSU to authorise the cancellation request.