# Weavr Simulator

This is a Simulator API which is only available on the Weavr Sandbox Environment

Version: v2

## Servers

```
https://sandbox.weavr.io/simulate/api
```

## Security

### API_Secret_Key

The API Secret Key - available from the Configuration area of the Innovator Portal

Type: apiKey
In: header
Name: programme-key

### Auth_Token

[object Object]

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

 - [Weavr Simulator](https://api.weavr.io/_bundle/products/simulator/openapi.yaml)

## Accounts

 - [POST /accounts/{account_id}/deposit](https://api.weavr.io/products/simulator/openapi/accounts/accounts_account_id_deposit.md): This tool is a quick and easy way to put funds on a Managed Account (previously called ‘deposit’), that you may need for testing elsewhere. Provide account id and transaction amount and the transactio
 - [POST /accounts/deposit](https://api.weavr.io/products/simulator/openapi/accounts/accounts_deposit.md): This tool is used to simulate incoming wire transfers (IWT) into managed accounts. IWTs are processed in line with the configuration of your application. For EUR and USD IWTs provide the destinationIb
## Cards

 - [POST /cards/{card_id}/expire](https://api.weavr.io/products/simulator/openapi/cards/cards_card_id_expire.md): Expire a managed card by Card ID. Provide card id and the card will be expired.
 - [POST /cards/{card_id}/about_to_expire](https://api.weavr.io/products/simulator/openapi/cards/cards_card_id_about_to_expire.md): Simulate a card about to expire by Card ID. Provide card id and the card will be set to about to expire.
 - [POST /cards/{card_id}/purchase](https://api.weavr.io/products/simulator/openapi/cards/cards_card_id_purchase.md): Simulate card purchases by Card ID. Provide card id and transaction amount and the transaction will be processed through the system.
 - [POST /cards/{card_id}/renew](https://api.weavr.io/products/simulator/openapi/cards/cards_card_id_renew.md): Renew a managed card by Card ID. Provide card id and the card will be renewed.
 - [POST /cards/{card_id}/merchant_refund](https://api.weavr.io/products/simulator/openapi/cards/cards_card_id_merchant_refund.md): Simulate card merchant refunds by Card ID. Provide card id and transaction amount and the transaction will be processed through the system.
 - [POST /cards/purchase](https://api.weavr.io/products/simulator/openapi/cards/cards_purchase.md): Simulate card purchases. Provide card details and transaction amount and the transaction will be processed through the system.
 - [POST /cards/merchant_refund](https://api.weavr.io/products/simulator/openapi/cards/cards_merchant_refund.md): Simulate card merchant refunds. Provide card details and transaction amount and the transaction will be processed through the system.
## Consumers

 - [POST /consumers/{consumer_id}/verify](https://api.weavr.io/products/simulator/openapi/consumers/consumers_consumer_id_verify.md): Fully verify a consumer identity. Will set emailVerified, mobileVerified, isPep (as false), isSanctioned (as false) and fullDueDiligence (as APPROVED).
## Corporates

 - [POST /corporates/{corporate_id}/verify](https://api.weavr.io/products/simulator/openapi/corporates/corporates_corporate_id_verify.md): Fully verify a corporate identity. Will set rootEmailVerified, rootMobileVerified, directorsVerified, UBOsVerified, basicCompanyChecksVerified and fullCompanyChecksVerified, while also setting dummy K
## Wiretransfers

 - [POST /wiretransfers/outgoing/{outgoing_wire_transfer_id}/accept](https://api.weavr.io/products/simulator/openapi/wiretransfers/wiretransfers_outgoing_outgoing_wire_transfer_id_accept.md): This endpoint is used to simulate the completion of an Outgoing Wire Transfer that has been submitted in the system and sent over our payment network.
 - [POST /wiretransfers/outgoing/{outgoing_wire_transfer_id}/reject](https://api.weavr.io/products/simulator/openapi/wiretransfers/wiretransfers_outgoing_outgoing_wire_transfer_id_reject.md): This endpoint is used to simulate the rejection of an Outgoing Wire Transfer that has been submitted in the system and sent over our payment network.
## Factors

 - [POST /factors/{credentials_id}/challenges/{challenge_id}/verify_invalid](https://api.weavr.io/products/simulator/openapi/factors/factors_credentials_id_challenges_challenge_id_verify_invalid.md)
 - [POST /factors/{credentials_id}/challenges/{challenge_id}/verify_expired](https://api.weavr.io/products/simulator/openapi/factors/factors_credentials_id_challenges_challenge_id_verify_expired.md)
 - [POST /factors/{credentials_id}/challenges/{challenge_id}/verify_success](https://api.weavr.io/products/simulator/openapi/factors/factors_credentials_id_challenges_challenge_id_verify_success.md)
## Linked Accounts

 - [POST /linked_accounts/{account_id}/set](https://api.weavr.io/products/simulator/openapi/linked-accounts/linked_accounts_account_id_set.md): Allows the verification or rejection of a linked account run by specifying the account ID. This operation updates the status of a linked account to either VERIFIED or REJECTED.
 - [POST /linked_accounts/{account_id}/verify](https://api.weavr.io/products/simulator/openapi/linked-accounts/linked_accounts_account_id_verify.md): This tool is used to simulate internal verification for linked accounts by Account ID.