Business API
Simulate an account top-up (Sandbox only)
api
post
/sandbox/topup

Simulate an account top-up (Sandbox only)

Simulate a top-up of your account in the Sandbox environment.

This is useful during testing, when you run out of money in your test account and need to add more.

For more information, see the guides: Test your flows with simulations (Sandbox only).

Access Token

Each Business API request must contain an authorization header in the following format to make a call: Bearer <your_access_token>.

The access token will be obtained the first time you set up your application and has an expiration of 40 minutes. During setup, a refresh_token will also be obtained which allows to obtain a new access_token.

danger

Never share your client-assertion JWT (JSON web token), access_token and refresh_token with anyone, as these can be used to access your banking data and initiate transactions.

Access tokens can be issued with four security scopes and require a JWT (JSON Web Token) signature to be obtained:

  • READ: Permissions for GET operations.

  • WRITE: Permissions to update counterparties, webhooks, and issue payment drafts.

  • PAY: Permissions to initiate or cancel transactions and currency exchanges.

  • READ_SENSITIVE_CARD_DATA: Permissions to retrieve sensitive card details.

    caution

    If you enable the READ_SENSITIVE_CARD_DATA scope for your access token, you must set up IP whitelisting. Failing to do so will prevent you from accessing any Business API endpoint.

    IP whitelisting means that you must specify an IP or a set of IPs which will be the only IPs from which requests to the API will be accepted. To do so:

    1. Go to the Revolut Business web app settings -> APIs -> Business API.
    2. Select the corresponding API certificate.
    3. In Production IP whitelist, provide the IP(s) which should be whitelisted, and save.

To configure your JWT and obtain the refresh and first access tokens, complete the following steps:

  1. Sign up for a Revolut Business account
  2. Prepare your Sandbox environment
  3. Make your first API request

Request

Top-up details

Request body
Body object

The ID of the account that you want to top up.

Possible values: <= 10000

The amount with which you want to top up the account.

Possible values: Value must match regular expression ^[A-Z]{3}$

ISO 4217 currency code in upper case.

Default value: Test Top-up

A short description for your top up.

Possible values: [pending, completed, reverted, failed]

Default value: completed

The state to which you want to set the top-up transaction.

Response

Information about the top-up state

Response body
Body object

The ID of the account that was topped up.

Possible values: [pending, completed, reverted, failed]

The state of the top-up transaction.

The date and time the transaction was created in ISO 8601 format.

The date and time the transaction was completed in ISO 8601 format.

Was this page helpful?
Loading...