Test the API in Sandbox Try-it
➤ Process
When you connect on 89C3 API portal, you can
call the Account information API through a form in which you will specify the application, the access / authentication token
then, you enter the method parameters that you want to test (either headers, either body) the ones with a star are mandatory parameters
Once the parameters entered, you can process the request : either you will get a result, either you will get an error.
For the GET /accounts/transactions and GET /accounts/balances methods, you must first execute the GET /accounts request in order to retrieve the current accounts list and the linked delayed debit cards. It will allow you to get the needed "ressourceId" for using these methods.
The data used to make the test in Try-It must come from the provided personas (see the use case "Test data").
The user can thus choose a specific profile for his test so as to better apprehend the obtained results.
If needed, to make the results easier to read, there will be a navigation with links to the different result pages (see examples in "Get accounts list" and "Get transaction history" use cases).
➤ Version 1.4.2
As of July 8, 2020, try-it will only be possible for version V1.4.2.
If you have already applied for GoLive, then you must create a new application and select the new STET API V1.4.2.
If you have NOT made a GoLive request, you can :
- either modify your existing application to associate it with the new STET V1.4.2 API
- either create a new application, then select the new STET V1.4.2 API
➤ Oauth2 token generation screen preview
This screen is accessible when editing the application (dsp2 in our case) ; it allows to generate or edit an Oauth2 token that will be selected in the Try-It execution form.
➤ Try-It execution form screen preview
➤ Try-It parameters for every Account information API method
For the body data type parameters you can copy paste the examples (left part of the screen) in the form (right part of the screen) by changing only the specific values of the chosen customer.
➤ Common parameters to every Account information API method
| Parameter | Description | Data type | Parameter type | Mandatory |
|---|---|---|---|---|
| Authorization | access token in header | Char | Header | Yes |
| PSU-IP-Address | IP address used by the customer logged-in to you app *mandated if the PSU is connected, otherwise "blank" if you use the batch mode | Char | Header | No* |
| PSU-IP-Port | IP port of the device used by the PSU connected to your app | Char | Header | No |
| PSU-HTTP-Method | http method used for the request | Char | Header | No |
| PSU-Date | Timestamp used for the PSU request | Char | Header | No |
| PSU-GEO-Location | Geographic location given by the PSU if available | Char | Header | No |
| PSU-User-Agent | Header "User-Agent" sent by the PSU device connected to your app | Char | Header | No |
| PSU-Referer | Header "Referer" or "Referrer" sent by the PSU device connected to your app | Char | Header | No |
| PSU-Accept | Header "Accept" sent by the PSU device connected to your app | Char | Header | No |
| PSU-Accept-Charset | Header "Accept-Charset" sent by the PSU device connected to your app | Char | Header | No |
| PSU-Accept-Encoding | Header "Accept-Encoding" sent by the PSU device connected to your app | Char | Header | No |
| PSU-Accept-Language | Header "Accept-Language" sent by the PSU device connected to your app | Char | Header | No |
| Digest | Body synthesis | Char | Header | No |
| Signature | HTTP request signature (see https://datatracker.ietf.org/doc/draft-cavage-http-signatures/) The header field "keyId" should be formatted as KeiId="SN=XXX,CA=YYYYYYYYYYYYYYYY" in which "XXX" is the serial number (hex format) of the QSEAL certificate QSEAL "YYYYYYYYYYYYYYYY" is the full name of the certification authority having issued this certificate A message HTTP 400 will be returned by the server in case of an invalid or missing signature | Char | Header | Yes |
| X-Request-ID | Consistency Header parameter to be included in the request, and it has to be returned in the response | Char | Header | Yes |
➤ Parametre dedicated to GET /accounts/{}/balances
| Parameter | Description | Data type | Parameter type | Mandatory |
|---|---|---|---|---|
| accountResourceId | Main identification of the account resource to fetch and used as input paramater by the request. It is obtained as the "GET /accounts" result in the "ressourceId" field | Char | Path | Yes |
➤ Parametre dedicated to GET /accounts/{}/transactions
| Parameter | Description | Data type | Parameter type | Mandatory |
|---|---|---|---|---|
| accountResourceId | Main identification of the account resource to fetch and used as input paramater by the request. It is obtained as the "GET /accounts" result in the "ressourceId" field | Char | Path | Yes |
| dateTo | Exclusive maximal imputation date of the transactions (transactions having an imputation date equal to this parameter are NOT included in the result) | Char | Request | No |
| dateFrom | Inclusive minimal imputation of the transactions (= those having an imputation date equal to this parameter are included in the result) | Char | Request | No |
| afterEntryReference | Specify the value on which the result has to be computed. Only transactions having a technical id GREATER than this value must be included in the result | Char | Request | No |