Simulator

Before you push your application to the Live environment, you should test your integration to make sure it handles flows correctly.

Use the simulator in your Sandbox Multi Portal to simulate processes and transactions that cannot be triggered by the integration alone such as a purchase on a card or a deposit on an IBAN.

info

You can also build automated tests by triggering the simulator via the simulator API.

Identity Verification

After you register a corporate or a consumer identity, you can simulate the approval of their KYB or KYC verification.

Consumer Identity KYC Verification

When you create a consumer identity, the KYC status of the identity fullDueDiligence is NOT-STARTED. To lift identity restrictions and change fullDueDiligence to APPROVED, you can simulate KYC verification as follows:

Using the Simulator API

# Replace $WEAVR_API_KEY with your API key found on the API Credentials page in the Multi Portal.
# Replace $CONSUMER_ID with the value of the `id.id` field of the response object returned when you created the consumer identity.
curl --location --request POST 'https://sandbox.weavr.io/simulate/api/consumers/{{$CONSUMER_ID}}/verify' \
--header 'Content-Type: application/json' \
--header 'programme-key: {{$WEAVR_API_KEY}}' \
--data-raw '{}'

Using the Simulator UI

1. Log in to the Multi Sandbox Portal using your credentials.
2. Navigate to Simulator > Verify Consumer (KYC).
3. Input the consumer ID that you would like to KYC verify and click on Simulate.

tip

You can find the consumer ID of a consumer identity in the Multi Portal by navigating to Home > Consumer Details.

KYB Verification

When you create a corporate identity, the KYB status of the identity fullCompanyChecksVerified is NOT-STARTED. To lift identity restrictions and change fullCompanyChecksVerified to APPROVED, you can simulate KYB verification as follows:

Using the Simulator API

# Replace $WEAVR_API_KEY with your API key found on the API Credentials page in the Multi Portal.
# Replace $CORPORATE_ID with the value of the `id.id` field of the response object returned when you created the corporate identity.
curl --location --request POST 'https://sandbox.weavr.io/simulate/api/corporates/{{$CORPORATE_ID}}/verify' \
--header 'Content-Type: application/json' \
--header 'programme-key: {{$WEAVR_API_KEY}}' \
--data-raw '{}'

Using the Simulator UI

1. Log in to the Multi Sandbox Portal using your credentials.
2. Navigate to Simulator > Verify Corporate (KYB).
3. Input the corporate ID that you would like to KYB verify and click on Simulate.

tip

You can find the corporate ID of a corporate identity in the Multi Portal by navigating to Home > Corporate Details.

Account Deposit

Managed accounts that have an IBAN can receive deposits from an external bank account.

When Weavr receives a new deposit, the funds are credited to the managed account linked to the destination IBAN and Weavr sends a deposit webhook notification to your application.

Using the Simulator API

# Replace $WEAVR_API_KEY with your API key found on the API Credentials page in the Multi Portal.
# Replace $IBAN with the value of the `bankAccountDetails.details.iban` field  in the response object returned by managedAccountIBANGet.
# Replace $PAYMENT_REFERENCE with the value of the `bankAccountDetails.paymentReference` field in the response object returned by managedAccountIBANGet.
# Replace $CURRENCY with the ISO-4217 code of the deposit currency that you would like to simulate.
# Replace $DEPOSIT_AMOUNT with the deposit amount that you would like to simulate. The amount should be scaled to the lowest denomination of the currency.
curl --location --request POST 'https://sandbox.weavr.io/simulate/api/accounts/deposit' \
--header 'Content-Type: application/json' \
--header 'programme-key: {{$WEAVR_API_KEY}}' \
--data-raw '{
  "iban": "{{$IBAN}}",
  "paymentReference": "{{$PAYMENT_REFERENCE}}",
  "depositAmount": {
    "currency": "{{$CURRENCY}}",
    "amount": {{$DEPOSIT_AMOUNT}}
  }
}'

Using the Simulator UI

1. Log in to the Multi Sandbox Portal using your credentials.
2. Navigate to Simulator > Deposit by IBAN.
3. Input the details in the form and click on Simulate.

tip

You can find the IBAN and the payment reference of a managed account in the Multi Portal by navigating to Home > Identity > Managed Accounts > Details.

caution

Not all managed accounts have a payment reference assigned to them. You need to specify the payment reference whenever it is provided.

Card Purchase

After Weavr issues a card, you can expect its cardholder to use it to make a purchase.

When Weavr is notified of a new purchase on a card, Weavr automatically updates the card’s balance and statement and sends a card purchase webhook notification to your application.

Using the Simulator API

# Replace $WEAVR_API_KEY with your API key found on the API Credentials page in the Multi Portal.
# Replace $CARD_ID with the value of the `id` field in the response object returned by managedCardGet.
# Replace $MERCHANT with the name that should be displayed as the merchant name for the simulated purchase.
# Replace $CURRENCY with the ISO-4217 code of the purchase currency that you would like to simulate.
# Replace $PURCHASE_AMOUNT with the purchase amount that you would like to simulate. The amount should be scaled to the lowest denomination of the currency.
curl --location --request POST 'https://sandbox.weavr.io/simulate/api/cards/{{$CARD_ID}}/purchase' \
--header 'Content-Type: application/json' \
--header 'programme-key: {{$WEAVR_API_KEY}}' \
--data-raw '{
  "merchantName": "{{$MERCHANT}}",
  "transactionAmount": {
    "currency": "{{$CURRENCY}}",
    "amount": {{$PURCHASE_AMOUNT}}
  }
}'

Using the Simulator UI

1. Log in to the Multi Sandbox Portal using your credentials.
2. Navigate to Simulator > Purchase by card ID.
3. Input the details in the form and click on Simulate.

By selecting Additional Information you will be able to include the following parameters to your simulation:

Field	Description
Merchant ID	Merchant’s unique identification number provided by the payment processor.
Merchant Category Code	4 digit number used to classify merchant’s business by services provided.
Forex Fee	Fee taken from the card for a purchase that involves foreign exchange (e.g. a cardholder uses an EUR card to make a purchase at a merchant who accepts USD)
Forex Padding	Additional padding to the forex amount

tip

You can find the card ID of a card in the Multi Portal by navigating to Home > Identity > Card > Details.