Weavr
Powered by Redocly

Weavr Simulator (2.16.0)

Download OpenAPI specification:Download

URL: https://weavr.io

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

Accounts

accounts_account_id_deposit

Simulating an Incoming Wire Transfer (deposit) using Account ID is a quick and easy way to put funds on a Managed Account, that you may need for testing elsewhere. This method skips some of the steps when processing IWTs (if you want to do this, use the POST /accounts/deposit endpoint).

SecurityAPI_Secret_Key
Request
path Parameters
account_id
required
integer <int64>
header Parameters
call-ref
string

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

Request Body schema: application/json
required
required
object

A message representing a monetary amount in a particular currency.

senderName
string
reference
string

The reference is the transaction description

receiverName
string

The name of the recipient of the deposit

txId
integer <int64>

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

senderIban
string <= 50 characters ^[a-zA-Z0-9_-]+$
object (SepaBankDetails)
object (FasterPaymentsBankDetails)
object (AccountDescriptorDetails)
paymentNetwork
string

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"
Responses
200

Success

400

Invalid Request

default

Error

post/accounts/{account_id}/deposit
Request samples
application/json
{
  • "depositAmount": {
    },
  • "senderName": "string",
  • "reference": "string",
  • "receiverName": "string",
  • "txId": 0,
  • "senderIban": "string",
  • "sepa": {
    },
  • "fasterPayments": {
    },
  • "accountDescriptor": {
    },
  • "paymentNetwork": "SEPA"
}
Response samples
application/json
{
  • "code": "COMPLETED"
}

accounts_deposit

Simulate an Incoming Wire Transfer (deposit) arriving into a Managed Account. IWTs are processed in line with the configuration of your application. Use the sender details and destination details to replicate the external payment details.

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

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

Request Body schema: application/json
required
iban
string
Deprecated

The iban of the account where the funds should be deposited to.

paymentReference
string

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

required
object

A message representing a monetary amount in a particular currency.

senderName
string

The name of the deposit sender

reference
string

The reference is the transaction description

receiverName
string

The name of the recipient of the deposit

txId
integer <int64>

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

object (IbanDetails)
object (FasterPaymentsDetails)
object (AccountDescriptorDetails)
object (IbanDetails)
object (FasterPaymentsDetails)
paymentNetwork
string

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"
Responses
200

Success

400

Invalid Request

default

Error

post/accounts/deposit
Request samples
application/json
{
  • "iban": "string",
  • "paymentReference": "string",
  • "depositAmount": {
    },
  • "senderName": "string",
  • "reference": "string",
  • "receiverName": "string",
  • "txId": 0,
  • "senderIbanDetails": {
    },
  • "senderFasterPaymentsDetails": {
    },
  • "senderAccountDescriptorDetails": {
    },
  • "destinationIbanDetails": {
    },
  • "destinationFasterPaymentsDetails": {
    },
  • "paymentNetwork": "SEPA"
}
Response samples
application/json
{
  • "code": "COMPLETED"
}
➔ Next to Accounts