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.

Request

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.

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.