Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
simulation

Simulate incoming Swift payment

Simulates an incoming Swift transfer into a profile's account details. This will create a payment into the user's account details and balance for the specified amount and currency. Using sandbox, you can test the initial tech build for webhook subscriptions, balance statements, and sweeping funds.

If the request is successful the transfer is logged in our back office, which triggers a swift-in#credit event and results in a balance update.

{% admonition type="info" %} While most fields are optional, default values will be provided as needed. {% /admonition %}

post/v1/simulation/profiles/{profileId}/swift-in

Path parameters

profileIdinteger required

The profile ID.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

currencyCodestring required

ISO 4217 currency code

amountnumber required

Amount received by Wise.

instructedCurrencyCodestring

ISO 4217 currency code

instructedAmountnumber

Amount sent by the sender. If not provided, it is assumed to be the same as amount plus same currency fees. Any outstanding fees in other currencies are ignored.

Required if instructedCurrencyCode is provided.

beneficiaryNamestring

Name of the ultimate beneficiary.

beneficiaryAccountstring

Account number of the ultimate beneficiary. It can be either a local account number or an IBAN. If the provided IBAN resolves to a BIC that does not match any connected test BICs, simulation is not allowed and an error is returned.

senderNamestring

Name of the sender.

senderBicstring

Business Identifier Code, also known as Swift Code.

senderAccountstring

Account number of the sender. It can be either an IBAN or local account number.

paymentReferencestring

Custom payment reference.

previousInstructingAgentsBic[]

List of previous instructing agents. Maximum 3 items.

Example request

{
  "currencyCode": "USD",
  "instructedCurrencyCode": "USD",
  "charges": [
    {
      "currency": "USD"
    }
  ]
}

Response

Swift payment simulated successfully.