v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

simulation

Simulate a balance top-up

Simulates a top-up so that a balance can be used to fund transfers and/or card spend.

post/v1/simulation/balance/topup

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.

profileIdinteger required

The profile ID linked to the balance account.

balanceIdinteger required

The ID of the balance account that is going to receive the funds.

currencystring required

The currency to top up the balance account in. Must be the same currency as the balance account.

amountnumber required

The amount to top up the balance account with.

channel'TRANSFER' | 'CARD'

Type of top-up. Not providing a channel will default to CARD.

Simulated balance top-up result.

transactionIdinteger

The ID of the top-up transaction.

statestring

The state of the transaction. COMPLETED is always returned when using this endpoint.