# 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

Authorization Token returned by login - example format: e6YrWi53lW0Bb6TbBL4ADA==

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

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

## Accounts

### Simulate incoming wire transfer using account id

 - [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 transaction will be processed through the system. This method skips some of the steps when processing IWTs. To test this fully, please use the accounts_deposit endpoint.

### Simulate an incoming wire transfer using IBAN

 - [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 destinationIbanDetails of your Managed Account, for GBP IWTs provide destinationFasterPaymentDetails or destinationIbanDetails of your Managed Account. Sender Details can also be added that is used to identify whether the IWT originated from a Linked Account (if configured) or a third party.

## Cards

### Simulate expiry of card

 - [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.

### Simulate card about to expire

 - [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.

### Simulate card purchase using card id

 - [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.

### Simulate renewal of card

 - [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.

### Simulate card merchant refund using card id

 - [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.

### Simulate card purchase using card number

 - [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.

### Simulate card merchant refund using card number

 - [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

### Simulate verification of a consumer identity

 - [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

### Simulate verification of corporate identity

 - [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 KYB Company Details

## Wiretransfers

### Simulate completion of  an Outgoing Wire Transfer

 - [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.

### Simulate rejection of an Outgoing Wire Transfer

 - [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

### Simulate invalid verification of specified challenge

 - [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)

### Simulate expiry of specified challenge

 - [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)

### Simulate successful verification of specified challenge

 - [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

### linked_accounts_account_id_set

 - [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.

### linked_accounts_account_id_verify

 - [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.