Skip to content
/
Simulate incoming wire tr...

Weavr Simulator (v2)

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

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
http://weavr.io
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/simulator/openapi
https://sandbox.weavr.io/simulate/api"

Accounts

Operations

Simulate incoming wire transfer using account id

Request

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.

Security
API_Secret_Key
Path
account_idinteger(int64)required
Headers
call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Bodyapplication/jsonrequired
depositAmountobjectrequired

A message representing a monetary amount in a particular currency.

depositAmount.​currencystring= 3 characters^[A-Z]*$required

The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

depositAmount.​amountinteger(int64)

The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

senderNamestring

The name of the person or business sending the incoming wire transfer

referencestring

The reference is the transaction description

receiverNamestring

The name of the recipient of the incoming wire transfer

txIdinteger(int64)

Id used for the transaction if provided, otherwise one will be generated

senderIbanstring<= 50 characters^[a-zA-Z0-9_-]+$
sepaobject(IBANDetails)
fasterPaymentsobject(FasterPaymentsBankDetails)
accountDescriptorobject(AccountDescriptorDetails)
paymentNetworkstring

Optional field which indicates the payment network to use. If not provided, a default payment network will be chosen based on the currency.

Enum"SEPA""FASTER_PAYMENTS""SWIFT""BACS""CHAPS""RIX"
curl -i -X POST \
  'https://api.weavr.io/_mock/products/simulator/openapi/accounts/{account_id}/deposit' \
  -H 'Content-Type: application/json' \
  -H 'call-ref: string' \
  -H 'programme-key: YOUR_API_KEY_HERE' \
  -d '{
    "depositAmount": {
      "currency": "str",
      "amount": 0
    },
    "senderName": "string",
    "reference": "string",
    "receiverName": "string",
    "txId": 0,
    "senderIban": "string",
    "sepa": {
      "iban": "stringstringstr",
      "bankIdentifierCode": "stringst"
    },
    "fasterPayments": {
      "accountNumber": "stringst",
      "sortCode": "string"
    },
    "accountDescriptor": {
      "accountDescriptor": "string"
    },
    "paymentNetwork": "SEPA"
  }'

Responses

Success

Bodyapplication/json
codestring(DepositResponseDepositResponseCode1)
Enum"COMPLETED""DENIED_ACCOUNT_NOT_FOUND""DENIED_AMOUNT_NOT_POSITIVE""DENIED_CURRENCY_NOT_ACCOUNT_CURRENCY""DENIED_ACCOUNT_INACTIVE""DENIED_INVALID_TX_ID""DENIED_OTHER""DENIED_ACCOUNT_NOT_UPGRADED_TO_IBAN"
Response
application/json
{
  "code": "COMPLETED"
}

Simulate an incoming wire transfer using IBAN

Request

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.

Security
API_Secret_Key
Headers
call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Bodyapplication/jsonrequired
paymentReferencestring

The payment reference is needed to identify which account, in cases where the same iban is used

depositAmountobjectrequired

A message representing a monetary amount in a particular currency.

depositAmount.​currencystring= 3 characters^[A-Z]*$required

The currency ISO-4217 code, i.e. a three letter uppercase code, such as GBP, EUR, USD.

depositAmount.​amountinteger(int64)

The monetary amount, scaled to the lowest denomination of the currency. For example, an amount of 1000 for a EUR currency is actually 1000 Euro cents, i.e. EUR 10.00.

senderNamestring

The name of the person or business sending the incoming wire transfer

referencestring

A reference provided by the sender of the incoming wire transfer.

receiverNamestring

The name of the recipient of the incoming wire transfer

txIdinteger(int64)

Id used for the transaction if provided, otherwise one will be generated

senderIbanDetailsobject(IbanDetails)
senderFasterPaymentsDetailsobject(FasterPaymentsDetails)
senderAccountDescriptorDetailsobject(AccountDescriptorDetails)
destinationIbanDetailsobject(IbanDetails)
destinationFasterPaymentsDetailsobject(FasterPaymentsDetails)
paymentNetworkstring

Optional field which indicates the payment network to use. If not provided, a default payment network will be chosen based on the currency.

Enum"SEPA""FASTER_PAYMENTS""SWIFT""BACS""CHAPS""RIX"
ibanstringDeprecated

The iban of the account the incoming wire transfer should be processed against

curl -i -X POST \
  https://api.weavr.io/_mock/products/simulator/openapi/accounts/deposit \
  -H 'Content-Type: application/json' \
  -H 'call-ref: string' \
  -H 'programme-key: YOUR_API_KEY_HERE' \
  -d '{
    "iban": "string",
    "paymentReference": "string",
    "depositAmount": {
      "currency": "str",
      "amount": 0
    },
    "senderName": "string",
    "reference": "string",
    "receiverName": "string",
    "txId": 0,
    "senderIbanDetails": {
      "iban": "string",
      "bankIdentifierCode": "string"
    },
    "senderFasterPaymentsDetails": {
      "sortCode": "string",
      "accountNumber": "string",
      "secondaryReference": "string"
    },
    "senderAccountDescriptorDetails": {
      "accountDescriptor": "string"
    },
    "destinationIbanDetails": {
      "iban": "string",
      "bankIdentifierCode": "string"
    },
    "destinationFasterPaymentsDetails": {
      "sortCode": "string",
      "accountNumber": "string",
      "secondaryReference": "string"
    },
    "paymentNetwork": "SEPA"
  }'

Responses

Success

Bodyapplication/json
codestring(DepositResponseDepositResponseCode0)
Enum"COMPLETED""DENIED_ACCOUNT_NOT_FOUND""DENIED_AMOUNT_NOT_POSITIVE""DENIED_CURRENCY_NOT_ACCOUNT_CURRENCY""DENIED_ACCOUNT_INACTIVE""DENIED_INVALID_TX_ID""DENIED_OTHER"
Response
application/json
{
  "code": "COMPLETED"
}

Cards

Operations

Consumers

Operations

Corporates

Operations

Wiretransfers

Operations

Factors

Operations

Linked Accounts

Operations