Sandbox assembly

Introduction - detailed features of the sandbox

 You can use the 89C3 API sandbox:

  • Via the 89c3 portal Try-It (see « Try-It console » use case) ;
  • Directly through your application by calling the payment initiation API of the 89c3-API platform (sandbox assembly).

In sandbox assembly, there are two types of requests:

  • A first request to retrieve the authorization token (see "Retrieve your access token") ;
  • A second one to send a request to the payment initiation API (see "Send a single payment initiation request" and "Retrieve the statuts of a payment request initiation").

Your application must request the AS (authentication server) to get an access token via its authentication key.

This access token will enable your application to submit the POST /payment-requests and the GET /payment-requests methods of the payment Initiation API.

You can perform a series of requests : 

  • Submit POST /payment-requests method to initiate a payment
  • Then, submit GET /payment-requests/{paymentRequestResourceId} with the parameter paymentRequestResourceId got in response of the first request, to get the payment status

The data used in the tests are based on persona (see “Test data” use case). This will enable you to choose specific profiles according to the tests.

 

The list of current available bank institutions for sandbox assembly for this API is detailed below ("bkcode" parameter used in URLs) :

 

Bank code Bank name Bank short name
13807 B.P Grand Ouest BPGO
13807 CMM Grand Ouest CMMGO
17515 Caisse d'Epargne Ile De France CEIDF
12579 Banque BCP BBCP

 

 

Sequence steps to test access to the PISP API from your APP

Prerequisites

You must declare your APP on 89c3 API portal (see "My apps" menu) and send us your QWAC and QSEALC test certificates public keys so we can :

  • Declare your APP as a consumer application of the API ;
  • Integrate your QWAC and QSEALC test certificates public keys in our infrastructure ;
  • Retrieve and control your organizationId and your "PISP" role in our TPP registry.

Please note that as a TPP, you must be accredited (or in the on-going accreditation process) by any european competent authority (ACPR in France) for this Payment Initiation Service Provider role ("PISP").

 

Retrieve your access token

This call allows you to retrieve the access token from the institution's authentication server, which is a prerequisite for each access to one of the payment initiation API methods. The description of this feature and the fields of the request are given in the "Retrieve your access token".

 

The entry point for accessing to the sandbox assembly is : www.<bkcode>.sandbox.api.89c3.com 

Request :

                POST https://www.13807.sandbox.api.89C3.com/stet/psd2/oauth/token

Headers :

Content-Type : application/x-www-form-urlencoded; charset=utf-8

Params :

client_id : PSDFR-ACPR-12345

grant_type : client_credentials

scope : pisp

 

Notes on parameters :

<bkcode> => bank code available in this environment :

13807 (Banque Populaire Grand Ouest) ;

17515 (Caisse d'Epargne Ile de France).

client_id : your agreement number as defined by your national competent authority. (PSDXX-YYYY-ZZZZZ)

grant_type => unchangeable = "client_credentials"

 

Response :

{

"access_token" : "nACXdBobTpdwRRaYy2H3w7pP5Xe61e1R9rwxMuhk7G0fULg8x6kJHz",

"token_type" : "Bearer",

"expires_in" : "3600",

"scope" : "pisp"

}

 

Notes on parameters :

access_token => tokenCredential to transmit in the header authorization of payment initiation API requests, next to Bearer XX.

expires_in => period of validity of the token in seconds

 

 

Send a single payment/transfer initiation request in euros

This call method post /payment-requests/ allows you to initiate a payment by asking the connected customer to give his consent for the payment.

The description of this feature and the fields of the request is given in the "Send a single payment request initiation" use case.

Reminder: the authentication method supported by the bank is the REDIRECT authentication approach => the sequence of PSU identification and strong authentication (SCA) screens described below correspond to this authentication mode.

 

The entry point for accessing to the sandbox assembly is identical : www.<bankcode>.sandbox.api.89c3.com 

Request :

                 POST https://www.13807.sandbox.api.89C3.com/stet/psd2/v1/payment-requests

Headers :

Authorization : Bearer nACXdBobTpdwRRaYy2H3w7pP5Xe61e1R9rwxMuhk7G0fULg8x6kJHz

Content-Type : application/json

Signature : keyId=\"MZGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDCFENGw33yGihy92pDjZQhl0C36rPJj+CvfSC8+q28hxA161QFNUd13wuCTUcq0Qd2qsBe/2hFyc2DCJJg0h1L78+6Z4UMR7EOcpfdUE9Hf3m/hs+FUR45uBJeDK1HSFHD8bHKD6kv8FPGfJTotc+2xjJwoYi+1hqp1fIekaxsyQIDAQAB\",algorithm=\"rsa-sha256\",headers=\"(request-target) psu-ip-address psu-ip-port psu-http-method psu-date psu-user-agent psu-referer psu-accept psu-accept-charset psu-accept-encoding psu-accept-language digest\",signature=\"LbkxgICM48J6KdWNaF9qT7OWEorNlAwWNo6R+KkP7cP4TIGkk8wxcsGQXJ9ZnC+ZiA8mjL5S8WQyL41M7iPt+vJX4xh679gdGwmlKzn7E+ZtZ1I4qalRxcdLp4gBL7fll+C2lVBNJrViMJBezFK7AYVjnSWH7t1QxiMVg3CmoRM=\

X-Request-ID : MyXrequestId123

 

Body :

                        {

                                    "paymentInformationId" : "MyPmtInfld123",

                                    "creationDateTime" : "2019-07-22T09:25:22.527+02:00",

                                    "numberOfTransactions" : 1,

                                    "debtorAgent" : {

                                               "bicFi" : "CCBPFRPP512",

                                               "name" : "B.P Grand Ouest",

                                               "postalAddress" : {

                                                           "country" : "FR",

                                                           "addressLine" : [

                                                                       "15 Boulevard de la Boutière",

                                                                       "CS 26858 35768 SAINT GREGOIRE CEDEX"

                                                           ]

                                               }

                                    },

                                    "initiatingParty" : {

                                               "name" : "MyPispName",

                                               "postalAddress" : {

                                                           "country" : "FR",

                                                           "addressLine" : [

                                                                       "5 avenue Anatole France ",

                                                                       "75007 PARIS"

                                                           ]

                                               },

                                               "organisationId" : {

                                                           "identification" : "12FR5",

                                                           "schemeName" : "COID",

                                                           "issuer" : "ACPR"

                                               }

                                    },

                                    "paymentTypeInformation" : {

                                               "serviceLevel" : "SEPA",

                                               "categoryPurpose" : "CASH"

                                    },

                                    "debtor" : {

                                               "name" : "Marc ",

                                               "postalAddress" : {

                                                           "country" : "FR",

                                                           "addressLine" : [

                                                                       "512 rue de la coupe du monde",

                                                                       "94512 Charenton-le-Pont"

                                                           ]

                                               },

                                               "privateId" : {

                                                           "identification" : "D0999990I0",

                                                           "schemeName" : "BANK",

                                                           "issuer" : "BICXYYTT512"

                                               }

                                    },

                                    "debtorAccount" : {

                                               "iban" : "FR7613807008043001965405255"

                                    },

                                    "beneficiary" : {

                                               "creditor" : {

                                                           "name" : "myMerchant",

                                                           "postalAddress" : {

                                                                       "country" : "FR",

                                                                       "addressLine" : [

                                                                                   "Place Charles de Gaulle",

                                                                                   "75008 PARIS"

                                                                       ]

                                                           },

                                                           "organisationId" : {

                                                                       "identification" : "852126790",

                                                                       "schemeName" : "BANK",

                                                                       "issuer" : "FR"

                                                           }

                                               },

                                               "creditorAgent" : {

                                                           "bicFi" : "CCBPFRPP512",

                                                           "name" : "B.P Grand Ouest",

                                                           "postalAddress" : {

                                                                       "country" : "FR",

                                                                       "addressLine" : [

                                                                                   "15 Boulevard de la Boutière",

                                                                                   "CS 26858 35768 SAINT GREGOIRE CEDEX"

                                                                       ]

                                                           }

                                               },

                                               "creditorAccount" : {

                                                           "iban" : "FR7613807008043001965406128"

                                               }

                                    },

                                    "purpose" : "COMC",

                                    "chargeBearer" : "SLEV",

                                    "requestedExecutionDate" : "2019-07-23T13:25:22.527+04:00",

                                    "creditTransferTransaction" : [

                                               {

                                                           "paymentId" : {

                                                                       "instructionId" : "MyInstrId123",

                                                                       "endToEndId" : "MyEndToEndId123"

                                                           },

                                                           "instructedAmount" : {

                                                                       "currency" : "EUR",

                                                                       "amount" : "327.12"

                                                           },

                                                           "remittanceInformation" : [

                                                                       "MyRemittanceInformation123"

                                                           ]

                                               }

                                    ],

                                    "supplementaryData" : {

                                               "acceptedAuthenticationApproach" : [

                                                           "REDIRECT",

                                                           "DECOUPLED"

                                               ],

                                               "scaHint" : "scaExemption",

                                               "successfulReportUrl" : "https://www.api.89c3.com/fr/",

                                               "unsuccessfulReportUrl" : "https://www.api.89c3.com/fr/nous-contacter"

                                    }

                        } 


Notes on parameters :

Authorization : Bearer => access_token recovered for the tokenCredential

Following data must be unique, otherwise the request is rejected because of duplicate (the replay is not allowed):

paymentInformationId ;

- instructionId ;

endToEndId ;

- x-request-id.

debtor/privateId/identification => customer remote banking identifier : when it is filled, the call to the identification screen of the customer is not made => this possibility will be available in the first half of 2020.

debtorAccount => customer's IBAN : when it is filled, the only account selectable for the customer is the one that corresponds to this IBAN.

The implemented features may differ between the Banques Populaires and the Caisses d'Epargne (see "Send a single payment initiation" use case).

 

Response :

{

"appliedAuthenticationApproach" : "REDIRECT",

"_links" : {

"consentApproval" : {

"href" : "https://www.rs-sandbox.api.89c3.com/89C3api/accreditation/v1/identificationPisp?paymentRequestRessourceId=0000000a22-156688979900016807956016&nonce=s7m9KD6UerBT1F5gPL3m&creditorName=QW1hem9uIFNB&iban=WVk2NENPSkg0MTA1OTU0NTMzMDIyMjk1Njk2MDc3MTMyMQ%3D%3D&amount=NDI%3D&currency=RVVS&successfulReportUrl=aHR0cDovL3R1cmJvc2EuYmFucXVlcG9wdWxhaXJlLmZyLw%3D%3D&unsuccessfulReportUrl=aHR0cHM6Ly93d3cuYXBpLjg5YzMuY29tL2ZyL2NvbXBvbmVudC9icGNlcG9ydGFsL3Byb2R1Y3RzLzQwL3VzZWNhc2VzLzU0,

"templated" : true

}

}

}

Headers :

X-Request-ID : MyXrequestId123

Status code : 201 OK

 

Notes on parameters :

paymentRequestRessourceId => identifier to pass to the  GET /payment-requests request to recover the status of the payment initiation request.

appliedAuthenticationApproach" = "REDIRECT" => only allowed value

href => URL of the redirection page to the identification and authentication screens of the banking institution

nonce => technical anti-replay

currency => recovered from the body given as input

successfulReportUrl => recovered from the body given as input 

unsuccessfulReportUrl => recovered from the body given as input 

iban => recovered from the body given as input 

creditorName => recovered from the body given as input 

X-Request-ID => transmitted as input

 

 

Nominal sequence of identification and strong authentication UX

 

nominal PISP kinematic 20190729

 

Sequence of identification and strong authentication screens:

Using the URI returned in consentApproval, it is possible to play the sequence of screens.

 

1) The PSU is redirected to an identification screen presented by his ASPSP (redirection mode) in which he will enter his remote banking identifier.

                 Warning : only one call to this screen can be made

                => the "nonce" parameter in the URL that gives access to this screen can only be used once (any second call with this nonce will rejected)

                => if necessary, a new call to PaymentRequests is required to get a new token.

PISP 3 1 Identification

 


The remote banking identifier of the customer is to be entered (see "Test data" use case for the data sets of the banking institution), example for the persona "Marc" of the Banques Populaires :

PISP 3 2 Identification

NB: If the PISP provides the remote banking identifier of the customer in its request (field "debtor/privateId/identification"), the following step is directly triggered : this possibility will be taken into account in the first half of 2020.

 

For Caisses d'Epargne, if the customer is a professional or a corporate, he will have to enter is user number in addition to his remote banking identifier.

 

1 3 ident PRO

 

 


2) The customer is redirected to a first authentication screen proposed by its ASPSP in order to validate his/her identity.

PISP 4 1 MireAuthenteBP bis

The SMS code for authentication is to be entered (see "Test data" use case for the data sets of the banking institution), example for the persona "Marc" of the Banques Populaires :

PISP 4 1 MireAuthenteBP penta



This sequence depends on the strong authentication method proposed to the customer by the bank (SMS OTP, soft token, etc...).

It also depends on the equipment connected to the PISP APP used by the customer (PC or mobile / smartphone / tablet).

 

3) The customer is redirected to a screen where he will have to select its account to be debited.

Example for the persona "Marc" of the Banques Populaires who has 4 accounts, three of which are eligible for DSP2 payment initiations (see "Test data" use case for the datasets of the banking institution):

PISP 5 1 AccountSelect

Note: If the PISP provides the IBAN of the customer to be debited in its request (field "debtorAccount"), only the corresponding account will be selectable and proposed to the customer : example below for the persona Tech'n Co of the Banques Populaires.

PISP 5 1 AccountSelect bis

NB: If the customer does not have an account, the request for payment initiation will not succeed and the customer will be redirected to your APP. Example for the persona "Thomas" of the Banques Populaires.

PISP X ErreurEligibilite

 


4) The customer selects and validates the account to be debited.

PISP 5 2 AccountSelect

 

 

5) The customer is redirected to a second strong authentication screen proposed by his banking institution to validate his payment (dynamic linking).

Screens are identical to the strong authentication screen of step 2) to validate the customer's identity.

Exemptions are possible for the SCA step to validate the payment => this possibility will not be available in 2020.

The PISP may provide an indicator to precise that it considers the payment request to be a strong authentication exemption case. The final decision whether or not to apply an authentication exemption is still at the discretion of the ASPSP.

Exceptions to the strong authentication requirement of the customer if the general authentication requirements are met are described in article 2 of the RTS of the DSP2.

 

6) The PSU is redirected to a confirmation screen of the transaction proposed by its ASPSP.

 PISP 7 Redirection

NB: when the customer does not validate the payment initiation (or in the event of a timeout on the account selection page for example) the customer is redirected to the next page :

PISP X ErreurAbonne

 

 

7) The customer is redirected to the PISP APP which provides in its first initiation request one or two call back URLs:

The first (successfulReportUrl) will be called by the banking institution in case the payment initiation request is processed and if the customer has given its consent for the payment.

The second call back URL (unsuccessfulReportUrl) will be used by the bank in case of refusal of consent or if the validation kinematics of the payment initiation is interrupted at one of its stages (example: timeout on the identification screen, on the account selection screen to be debited or the strong authentication screens). This second URL is optional : the first URL call back (successfulReportUrl) will be used if the second is not filled.

 

 

Sequence of the identification and strong authentication screens when the remote bank identifier of the customer is transmitted in the request:

When the access identifier for the remote bank for the customer (debtor/privateId/identification field in the payment initiation request) is filled in, the call to the identification screen of the customer is not performed, cf. drawing below => this possibility will be available in the first half of 2020.

PISP kinematic with rmId transmitted 20190729

 

 

Retrieve the status of a payment/transfer initiation request

This method get /payment-requests/{paymentRequestResourceId}  allows you to retrieve all the payment initiation data enriched with the resource identifiers and the status of the payment initiation it contains.

The description of this feature and fields of the request is described in the use case "Retrieve the status of a payment request initiation". The data is accessible for 35 days.

 

For accessing to the sandbox assembly, the entry point is identical : 

Request :

GET https://www.13807.sandbox.api.89c3.com/stet/psd2/v1/payment-requests/0000000386-155532845000030007970322

Headers :

Authorization : Bearer nACXdBobTpdwRRaYy2H3w7pP5Xe61e1R9rwxMuhk7G0fULg8x6kJHz

Content-Type : application/json

Signature : keyId=\"MZGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDCFENGw33yGihy92pDjZQhl0C36rPJj+CvfSC8+q28hxA161QFNUd13wuCTUcq0Qd2qsBe/2hFyc2DCJJg0h1L78+6Z4UMR7EOcpfdUE9Hf3m/hs+FUR45uBJeDK1HSFHD8bHKD6kv8FPGfJTotc+2xjJwoYi+1hqp1fIekaxsyQIDAQAB\",algorithm=\"rsa-sha256\",headers=\"(request-target) psu-ip-address psu-ip-port psu-http-method psu-date psu-user-agent psu-referer psu-accept psu-accept-charset psu-accept-encoding psu-accept-language digest\",signature=\"LbkxgICM48J6KdWNaF9qT7OWEorNlAwWNo6R+KkP7cP4TIGkk8wxcsGQXJ9ZnC+ZiA8mjL5S8WQyL41M7iPt+vJX4xh679gdGwmlKzn7E+ZtZ1I4qalRxcdLp4gBL7fll+C2lVBNJrViMJBezFK7AYVjnSWH7t1QxiMVg3CmoRM=\

X-Request-ID : MyXrequestId123

 

Notes on parameters :

Authorization:Bearer => access_token retrieved for tokenCredential.

x-request-id => must be the same as for the payment initiation request.

The paymentRequestRessourceId is retrieved in response to the payment initiation request, when the payment initiation has been processed and the PSU has given its consent for the payment.

 

Response :

{

  "paymentRequest" : {

    "resourceId" : "0000000a22-146329369000016907660677",

    "paymentInformationId" : "MyPmtInfld123",

    "creationDateTime" : "2019-07-22T09:25:22.527+02:00",

    "numberOfTransactions" : 1,

    "debtorAgent" : {

        "bicFi" : "CCBPFRPP512",

        "name" : "B.P Grand Ouest",

        "postalAddress" : {

            "country" : "FR",

            "addressLine" : [

                "15 Boulevard de la Boutière",

                "CS 26858 35768 SAINT GREGOIRE CEDEX"

            ]

        }

    },

    "initiatingParty" : {

      "name" : "MyPispName",

      "postalAddress" : {

        "country" : "FR",

        "addressLine" : [

          "5 avenue Anatole France ",

          "75007 PARIS"

        ]

      },

      "organisationId" : {

        "identification" : "12FR5",

        "schemeName" : "COID",

        "issuer" : "ACPR"

      }

    },

    "paymentTypeInformation" : {

      "serviceLevel" : "SEPA",

      "categoryPurpose" : "CASH"

    },

    "debtor" : {

      "name" : "Marc ",

      "postalAddress": {

        "country" : "FR",

        "addressLine" : [

          "512 rue de la coupe du monde",

          "94512 Charenton-le-Pont"

        ]

      },

      "privateId" : {

        "identification" : "D0999990I0",

        "schemeName" : "BANK",

        "issuer" : "BICXYYTT512"

      }

    },

    "debtorAccount" : {

      "iban" : "FR7613807008043001965405255"

    },

    "beneficiary" : {

      "creditorAgent" : {

        "bicFi" : "CCBPFRPP512",

        "name" : "B.P Grand Ouest",

        "postalAddress" : {

          "country" : "FR",

          "addressLine" : [

            "15 Boulevard de la Boutière",

            "CS 26858 35768 SAINT GREGOIRE CEDEX"

          ]

        }

      },

      "creditor" : {

        "name" : "myMerchant",

        "postalAddress" : {

          "country" : "FR",

          "addressLine": [

            "Place Charles de Gaulle",

            "75008 PARIS"

          ]

        },

        "organisationId" : {

          "identification" : "852126790",

          "schemeName" : "BANK",

          "issuer" : "FR"

        }

      },

      "creditorAccount" : {

        "iban" : "FR7613807008043001965406128"

      }

    },

    "purpose" : "COMC",

    "chargeBearer" : "SLEV",

    "paymentInformationStatus" : "PDNG",

    "statusReasonInformation" : null,

    "fundsAvailability" : null,

    "booking": null,

    "requestedExecutionDate" : "2019-07-23T13:25:22.527+04:00",

    "creditTransferTransaction" : [

      {

        "paymentId" : {

          "resourceId" : "0000000a22-146329369000016907660677",

          "instructionId" : "MyInstrId123",

          "endToEndId" : "MyEndToEndId123"

        },

        "instructedAmount" : {

          "currency" : "EUR",

          "amount" : "327.12"

        },

        "remittanceInformation" : [

          "MyRemittanceInformation123"

        ],

        "transactionStatus" : "PDNG"

      }

    ],

    "supplementaryData" : {

      "appliedAuthenticationApproach" : "REDIRECT",

      "scaHint" : "scaExemption",

      "successfulReportUrl" : "https://www.api.89c3.com/fr/",

      "unsuccessfulReportUrl" : "https://www.api.89c3.com/fr/nous-contacter"

    }

  }

}

Headers :

X-Request-ID : MyXrequestId123

Status code : 200 OK

Notes on parameters :

resourceId => equals to paymentRequestRessourceId

paymentInformationStatus => gives payment initiation status

transactionStatus => gives transaction status

X-Request-ID => transmitted as input

 

 

Cancel a payment/transfer initiation request

This feature will be available in June 2020.

 

 

Confirm a payment/transfer initiation request or a payment/transfer cancellation request

This feature will be implemented with STET standard v1.4.2.17