Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
simulation

Simulate transfer payout failure

Triggers transfers#payout-failure webhook for the transfer.

The available payout failure reason codes are listed in the transfers#payout-failure webhook guide.

{% admonition type="info" %}

  • Simulation requires transfer to be in bounced_back state.
  • While payout failure simulation call will respond with 200 in real time, the payout failure webhook is asynchronous. {% /admonition %}

Request body is optional; omit it or send {} to trigger a random failure reason.

post/v1/simulation/transfers/{transferId}/payout-failure

Path parameters

transferIdinteger required

The ID of the transfer to simulate.

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

failure_reason_codestring

Failure reason code to trigger for payout failure. When not provided, a failure code is selected at random and returned.

Response

Successful initiation of payout failure.