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

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

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

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(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"

ibanstringdeprecated

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

curl -i -X POST \
  https://sandbox.weavr.io/simulate/api/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

{
  "code": "COMPLETED"
}