Business API
Simulate a transfer state update (Sandbox only)
api
post
/sandbox/transactions/{id}/{action}

Simulate a transfer state update (Sandbox only)

Simulate a transfer state change in the Sandbox environment.

For example, after you make a transfer in Sandbox, you can change its state to completed. The resulting state is final and cannot be changed.

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​

Path Parameters
Path Parameters

The ID of the transfer whose state you want to update.

Possible values: [complete, revert, decline, fail]

Indicates the transaction state update. Possible values:

  • complete - Transaction is successfully processed.
  • revert - Transaction is reverted by the system or company, but not the user. This can happen for a variety of reasons, for example, the receiver being inaccessible.
  • decline - Transaction is declined to the user for a good reason, such as insufficient account balance, wrong receiver information, etc.
  • fail - Transaction fails during initiation or completion. This can happen for a variety of reasons, for example, invalid API calls, blocked payments, etc.

Response​

Information about the updated transfer state

Response body
Body object 

The ID of the transfer whose state was updated.

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

Indicates the simulated transaction state. Possible values:

  • completed - Transaction was successfully processed.
  • reverted - Transaction was reverted by the system or company, but not the user. This can happen for a variety of reasons, for example, the receiver being inaccessible.
  • declined - Transaction was declined to the user for a good reason, such as insufficient account balance, wrong receiver information, etc.
  • failed - Transaction failed during initiation or completion. This can happen for a variety of reasons, for example, invalid API calls, blocked payments, etc.

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

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

Was this page helpful?
Loading...