Skip to content

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
depositAmountobject(CurrencyAmount)required

A message representing a monetary amount in a particular currency.

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(TransferType)

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://sandbox.weavr.io/simulate/api/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
{
  "code": "COMPLETED"
}