Sandboxes

Sandbox providers are providers designed to allow integrators of the Qard API to test their implementations and integrations of our data without requiring them to first find a prospective customer willing to contribute their own accounts. It does so by providing a set of fixture data, that is accessed the same way any other provider's data would, by synchronizing it, and then fetching it from the appropriate endpoints.

Here are the sandbox providers for your tests:

Banking sandbox_openbanking	Cashflow Credit Insights Bank Account Bank Transaction	The Sandbox Banking provider simulates the flow of requiring the user to authorize access to their data. To finalize the connection of this provider, you will have to manually navigate to the url described the field redirect_url, simulating the actions of a user.
Public data sandbox_public	Company Profile Company Officer Corporate Office Corporate Tax Act Articles of association Insee Registration Proof Collective Procedure Financial Statement Tax Return Tax Return Analysis Beneficial Owner Court Decision Timeline Background Check Banking Relationship Trademark Registration Proof	The Public data Sandbox provider simulates a public data provider, and so does not need to simulate a user authorizing access to their data. To simulate an invalid Background Check, you can create : a legal user with one of these SIREN numbers: FINANCIAL_DIFFICULTIES 824256283 COMPANY_ADDRESS_BLACKLISTED 500761564 894401405 INACTIVE_COMPANY 500761564 CLOSED_COMPANY 822748182 BENEFICIAL_OWNER_NATIONALITY_BLACKLISTED 833618093 or a natural user with this informations: RELATED_FINANCIAL_DIFFICULTIES Lastname : Doe Firstname : John Birthdate : 1900-01-01
Private data sandbox_private	Financial Statement Tax Return Tax Return Analysis Vat Declaration Corporate Tax Tax Clearance Certificate Tax Account	The Sandbox Private provider simulates the flow of requiring the user to authorize access to their data. To finalize the connection of this provider, you will have to manually navigate to the url described the field redirect_url, simulating the actions of a user.
Commercial sandbox_commerce	Commerce Transaction Commerce Balance Commerce Dispute Commerce Subscription Commerce Customer Commerce Product Commerce Location Commerce Order Commerce Transactions Insight Commerce Disputes Insight Commerce Subscriptions Insight	The Sandbox Commerce provider simulates the flow of requiring the user to authorize access to their data. To finalize the connection of this provider, you will have to manually navigate to the url described the field redirect_url, simulating the actions of a user.

Sandboxes Integration

1. Enable the Sandbox

(PUT) /api/v6/providers/sandbox_commerce

{
  "enable": true
}

2. Settings Sandbox provider:

(PUT) /api/v6/providers/sandbox_commerce/settings

{
  "auto_connect": (true|false)
}

3. Create Sandbox data connection:

(POST) /api/v6/users/{userId}/data-connections

{
  "requested_data_types": [
    "COMMERCE_TRANSACTION",
    "COMMERCE_BALANCE",
    "COMMERCE_DISPUTE",
    "COMMERCE_SUBSCRIPTION",
    "COMMERCE_CUSTOMER",
    "COMMERCE_PRODUCT",
    "COMMERCE_LOCATION",
    "COMMERCE_ORDER",
    "COMMERCE_TRANSACTION_INSIGHT",
    "COMMERCE_SUBSCRIPTION_INSIGHT",
    "COMMERCE_DISPUTE_INSIGHT"
  ],
  "provider_name": "sandbox_commerce"
}

3.1 Simulate the user authorization by navigating to the redirect_url find in the response body:

Extra step only for the following providers : sandbox_commerce, sandbox_openbanking and sandbox_private.

{
    ...
    "redirect_url": "https://api.qardfinance.com/connect/5d4b4c862666a12e7dcecd16ae68fb3f9af2eb5e35f85fa3da0fa51b9caba125",
    ...
}

3. Create a synchronization:

After validating that the data connection status is CONNECTED, you can run a new synchronization.

(POST) /api/v6/users/{userId}/sync

{
  "data_types": [
      "COMMERCE_TRANSACTION",
      "COMMERCE_BALANCE",
      "COMMERCE_DISPUTE",
      "COMMERCE_SUBSCRIPTION",
      "COMMERCE_CUSTOMER",
      "COMMERCE_PRODUCT",
      "COMMERCE_LOCATION",
      "COMMERCE_ORDER",
      "COMMERCE_TRANSACTION_INSIGHT",
      "COMMERCE_SUBSCRIPTION_INSIGHT",
      "COMMERCE_DISPUTE_INSIGHT"
  ]
}