# Quickstart

Not sure where to start? Find below the testing steps for you to perform in Sandbox to start exploring the Treezor API capabilities.

Bulb icon

Tip – Rely on Treezor Webhooks and Dashboard

These tools will allow you to better visualize the results of your testing.

# Authenticate to your Sandbox

books icon

Reading – Related documentation in API Basics

Environments | Credentials | Authentication | Scope & Permissions

Once you have your client_id and client_secret for your Sandbox environment, you can generate your Json Web Token that you will use to authenticate your API requests.

Returns the access_token for you to use in the Authorization header of all your subsequent requests.

Note icon

Note – The access token expires after 1 hour

Read how to extend its lifetime in the Authentication article.

# Create a User

books icon

Reading – Related documentation

Users | Physical Users

In this example, your end user is a physical person to whom you will offer banking services thanks to Treezor.

You can use the following request to create a physical user.

Here is a {payload} example:

Returns the new User with its id (1545392) that you will use for the next steps.

Note icon

Note – Treezor API offers a variety of Users to fit your use cases

You could also create other types of users, such as Legal Entities and Anonymous Users. Users can also be linked by hierarchical relations referred to as parent-children relations.

# Simulate User KYC validation

books icon

Reading – Related documentation

User verification (KYC) | KYC Simulation

In real life, Users must be verified to use Treezor services. This process includes sending documents and declarative data for Treezor to manually approve the User.

In Sandbox, you can use the following request to force the KYC validation, allowing you to proceed with the next steps.

Here is a {payload} example with the .validated suffix to approve the KYC in Sandbox:

Returns the new User, but you might not see they are verified right away.

You need to make a GET {baseUrl}/v1/users/{userId} call to see the User object with the updated kycLevel and kycReview.

# Create a Wallet

books icon

Reading – Related documentation

Wallets | Wallet Creation

Let's create a payment account, which is represented by the Wallet object in the API. We will define the previously created User as its owner.

Here is a {payload} example:

Returns a Wallet object, with its id (826210) and its ready-to-use IBAN:

Note icon

Note – Treezor API offers a variety of Wallets to fit your use cases

There are different types of wallets, some requiring KYC validation, some that don't.

# Credit the Wallet

books icon

Reading – Related documentation

Wallets | SEPA Transfers | SCTR Simulation

Let's simulate a payin into a Wallet by emulating an incoming SEPA Transfer. These ficticious funds will then be useful to further test Treezor abilities, such as payouts to external accounts, or Wallet-to-Wallet transfers.

Here is the simulation request, in which you must pass the IBAN of the wallet to credit and the amount (integer) to credit as query parameters.

Returns the id of the SCTR, its txId (transaction id) and its payinId.

Note icon

Note – Discover all the ways to credit a Wallet

Treezor offers a large range of payins for you to credit wallets. Learn more in the How to credit wallets article.

# Check the Wallet Balance

books icon

Reading – Related documentation

Wallets | Balances

Let's make sure the Wallet was properly credited by checking its Balance.

Use the following request to retrieve a given Wallet Balance, with the corresponding walletId expected as a query parameter.

Returns the Balance object, with both the Authorized Balance (authorizedBalance) and Balance (currentBalance).

Bulb icon

Tip – Balance History is available

The dedicated Balance History endpoint gives the Balance evolution over time.

# Create a Beneficiary

books icon

Reading – Related documentation

Beneficiaries | SEPA Transfers

To send money to bank accounts outside of your Treezor environment, you must create a Beneficiary beforehand.

Here is an example of {payload}:

Returns the Beneficiary object, with its id allowing you to send funds to it using a Payout.

# Send funds to an external account

books icon

Reading – Related documentation

Wallets | SEPA Transfers

This sends funds from the created Wallet, to the created Beneficiary using a SEPA transfer.

Here is an example of {payload} with an amount ending in 1.25 for the simulation:

Returns a Payout object with its id.

Bulb icon

Tip – SEPA Direct Debit also available

You could also use Direct Debit to debit funds from the Wallet to an external account.

# Send funds to another Wallet

books icon

Reading – Related documentation

Wallets | Wallet-to-Wallet Transfers

You can also transfer funds from one Wallet to another in your Treezor environment.

Here is a {payload} example:

Returns a Transfer object.

You can now recheck the balance of the Wallet.

# Create a Card to make payments

books icon

Reading – Related documentation

Cards | Card Program | Card Creation

If you already have a cardPrint provided once your Card Program is set up, you can test the creation of Virtual Card and/or Physical Cards.

Let's take the example of the Virtual Card creation.

Here is an example of {payload}:

Returns a Card object with its id, expiration date, CVV, etc.

Note icon

Note – A lot of options come with your Card Product

You can also set withdrawals or payments limits, allow contactless payments, allow ATM withdrawals, restrict its use in some countries, by business category (such as restaurants) or with specific merchants only. And you can even digitize this Card with Apple Pay, Google Pay or Samsung Pay so that your Users can pay with their smartphones.

# Simulate a Card Transaction

books icon

Reading – Related documentation

Cards | Card Transactions | Card Transaction simulation

Now that you've created a Virtual Card, you may simulate a Card Transaction.

Here is a {payload} example:

The request returns a 201 HTTP Status Code without any content.

Note icon

Note – Disclaimers about this emulation

  • No impact on Wallet Balances: A balance.update webhook is sent, but values are set to 0.
  • No refunds and negative amount settlements support yet.
Last Updated: 4/10/2024, 7:14:25 AM