Our Apis

Payment initiation 1.4.2

Overview

The Payment initiation API allows you to initiate :

  • a payment request on behalf of a merchant
  • a transfer or standing-order request on behalf of the account's owner

In accordance with STET specifications, the payment-request will have to be validated by the Payment Service User (PSU) in a REDIRECT Approach. In this version 1.4.2, only the Enforced REDIRECT Approach is supported. 

Test It !

The sandbox page describes how to obtain access token for a particular use case. Once you have the access token you will be able to quickly test the API in the API Reference section below.

  • Under "API Reference", expand the endpoint description you want to test and click on “Try it out”
  • Fill the fields of the request and body (if any) 
    • access token has to be specified in the Authorization header (Bearer scheme) 
      For instance : "Bearer ygzVxruT52IkFZw5GOAYAq82ZFaH"
    • Signature and X-Request-ID headers are not used out of the production mode and they won’t be any in the response
      But because the header is specified as "required" in OpenAPI specification you will have to specify any value
  • Click on “Execute” to send the request

The API can off course be used with the same access token outside this page with or without a mutual TLS connection.

Go Live !

The production mode is available, you can see how it works here.

Functional details

STET version compatibility : 1.4.2.18 (partial - see below)

  • Cancellation endpoint (PUT PUT /payment-requests/{paymentRequestResourceId}) is supported for scheduled payment and standing order.
  • Date and Time (requestedExecutionDate field for example) MUST always conform to the ISO 8601 format e.g.: 2017-06-21T14:07:17Z (date time),  it MUST use the UTC (without time offsets).
  • The "country" field (into postalAdress object) is required in Arkéa implementation for the debtor and benificiary.creditor.
  • Debtor object is mandatory for scheduled payments and standing orders.
  • If you specify a requestedExecutionDate, the value cannot exceed 180 days in the future.

Here after is a summary of the functionnalities supported by the different entities

Feature CMB CMSO Fortuneo Max ABP AZB BPE ABEI ABS
SCT (SEPA Payments) X X X X X X X X X
SCT Multiple (SEPA payment with several payment instructions) X* X* NC NC X* NC NC X NC
SCT Scheduled and standing orders (SEPA with requestedExecutionDate) X X X X X X X X X
SCT Inst (SEPA Instant Payments) X X X X NC NC NC X NC
International (Domestic payments in non-euro currency and international payments) X X NC NC X X X X X
International Scheduled and standing orders (requestedExecutionDate specified) X X NC NC X X X X X

NC : Not Concerned
* : not available for Private Accounts

CMB : Crédit Mutuel de Bretagne
CMSO : Crédit Mutuel du Sud-Ouest
ABEI : Arkéa Banque Entreprises et Institutionnels
ABP : Arkéa Banque Privée
ABS : Arkéa Banking Services
AZB : Allianz Banque

Feature

Payment request on behalf of a merchant

Transfer or standing-order request on behalf of the account's owner
SCT (SEPA Payments) X (categoryPurpose=DVPM) X (categoryPurpose=CASH)
SCT Multiple (SEPA payment with several payment instructions) Not supported X
SCT Scheduled and standing orders (SEPA with requestedExecutionDate) X X
SCT Inst (SEPA Instant Payments) X X
International (Domestic payments in non-euro currency and international payments) Not supported X
International Scheduled and standing orders (requestedExecutionDate specified) Not supported X

 

API reference