Simulate settlement allocation funds received

Request

Simulates the receipt of funds for a specific settlement allocation. This endpoint allows you to simulate the receipt of funds associated with a given allocation, which can be useful for testing and validation purposes. Upon successful simulation, a 204 No Content response is returned.

Security

ClientCredentialsToken

X-External-Correlation-Idstring, (uuid), <= 36 characters

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

Example:f47ac10b-58cc-4372-a567-0e02b2c3d479

Bodyapplication/jsonrequired

amountnumber, (decimal), > 0required

The amount to be simulated as received.

Example:1000.5

currencystring, = 3 characters^[A-Z]{3}$required

Currency code (ISO 4217).

Example:"JPY"

paymentReferencestring, non-empty\Srequired

Payment reference for the settlement allocation. Must start with 'BYOPSP_'.

Example:"BYOPSP_test-client_A1B2C3"

curl -i -X POST \
  https://api.wise.com/2026Q4/simulation/settlement/funds \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-External-Correlation-Id: f47ac10b-58cc-4372-a567-0e02b2c3d479' \
  -d '{
    "amount": 1000.5,
    "currency": "JPY",
    "paymentReference": "BYOPSP_test-client_A1B2C3"
  }'

Responses

Funds received simulation completed successfully.

Headers

X-External-Correlation-Idstring, (uuid), <= 36 characters

Echoed back when X-External-Correlation-Id was included in the request. Learn more.

Example:"f47ac10b-58cc-4372-a567-0e02b2c3d479"

x-trace-idstring

Unique trace identifier assigned by Wise. Useful when contacting support about a specific request.

Example:"fba501b6d453b96789f52338f019341f"

Response

No content