Simulate

Simulate the update of the limit.

post
/simulate/clients/{clientId}/limit/updated

Simulate the update of the limit for a client. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
clientIdstringRequired

The unique identifier of the client.

Body
limitnumberRequired

The new limit for the manager's client, in USD with two decimal places.

Responses
chevron-right
201

The limit has been updated.

No content

post
/simulate/clients/{clientId}/limit/updated

No content

Simulate the creation of a preset fee for a manager's client.

post
/simulate/clients/{clientId}/preset-fees/created

Simulate the creation of a preset fee for a manager's client. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
clientIdstringRequired

The unique identifier of the client.

Body
or
Responses
chevron-right
201

The preset fee has been created.

No content

post
/simulate/clients/{clientId}/preset-fees/created

No content

Simulate the deletion of a preset fee for a manager's client.

post
/simulate/clients/{clientId}/preset-fees/{presetFeeId}/deleted

Simulate the deletion of a preset fee for a manager's client. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
clientIdstringRequired

The unique identifier of the client.

presetFeeIdstringRequired

The ID of the preset fee to delete

Responses
post
/simulate/clients/{clientId}/preset-fees/{presetFeeId}/deleted

No content

Simulate the creation of a preset fee.

post
/simulate/preset-fees/created

Simulate the creation of a preset fee for a client. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Body
or
Responses
chevron-right
201

The limit has been updated.

No content

post
/simulate/preset-fees/created

No content

Simulate the deletion of a preset fee.

post
/simulate/preset-fees/{presetFeeId}/deleted

Simulate the deleteion of a preset fee for a client. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
presetFeeIdstringRequired

The ID of the preset fee to delete

Responses
post
/simulate/preset-fees/{presetFeeId}/deleted

No content

Simulate the initiation of a transaction.

post
/simulate/transactions/{transactionId}/initiated

Simulate the initiation of a transaction for a client. This route is a helper for clients to autonomously test and integrate with the Rialto APIs. In production, transaction advancement is done by Rialto's back-office. The transaction must be in IDLE status. This route is only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
transactionIdstringRequired

The ID of the transaction to initiate

Body
transactionHashOrWireTransferReferencestring | nullOptional

The transaction hash or wire transfer reference.

initiationAmountnumberRequired

The amount received in the transaction.

post
/simulate/transactions/{transactionId}/initiated

Simulate the completion of a transaction.

post
/simulate/transactions/{transactionId}/completed

Simulate the completion of a transaction for a client. This route is a helper for clients to autonomously test and integrate with the Rialto APIs. In production, transaction advancement is done by Rialto's back-office. The transaction must be in INITIATED status. This route is only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
transactionIdstringRequired

The ID of the transaction to complete

Body
conversionRatenumberRequired

The conversion rate used to calculate the amount of the transaction.

post
/simulate/transactions/{transactionId}/completed

Simulate the dismissal of a transaction.

post
/simulate/transactions/{transactionId}/dismissed

Simulate the dismissal of a test transaction. This route is a helper for clients to autonomously test and integrate with the Rialto APIs. In production, transactions are dismissed by Rialto admins. The transaction must be in IDLE or INITIATED status. This route is only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
transactionIdstringRequired

The ID of the transaction to dismiss

Body
reasonnumberRequired

The reason to dismiss the transaction.

Responses
chevron-right
201

The transaction has been dismissed.

No content

post
/simulate/transactions/{transactionId}/dismissed

No content

Simulate the approval of a bank account.

post
/simulate/clients/{clientId}/bank-accounts/{bankAccountId}/approved

Simulate the approval of a bank account for an account manager's client. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
clientIdstringRequired

The unique identifier of the client.

bankAccountIdstringRequired

The ID of the bank account to approve

Responses
post
/simulate/clients/{clientId}/bank-accounts/{bankAccountId}/approved

Simulate the rejection of a bank account.

post
/simulate/clients/{clientId}/bank-accounts/{bankAccountId}/rejected

Simulate the rejection of a bank account for a client. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
clientIdstringRequired

The unique identifier of the client.

bankAccountIdstringRequired

The ID of the bank account to reject

Responses
post
/simulate/clients/{clientId}/bank-accounts/{bankAccountId}/rejected

No content

Simulate the approval of a blockchain wallet.

post
/simulate/clients/{clientId}/blockchain-wallets/{blockchainWalletId}/approved

Simulate the approval of a blockchain wallet for a client. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
clientIdstringRequired

The unique identifier of the client.

blockchainWalletIdstringRequired

The ID of the blockchain wallet to approve

Responses
post
/simulate/clients/{clientId}/blockchain-wallets/{blockchainWalletId}/approved

Simulate the rejection of a blockchain wallet.

post
/simulate/clients/{clientId}/blockchain-wallets/{blockchainWalletId}/rejected

Simulate the rejection of a blockchain wallet for a client. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
clientIdstringRequired

The unique identifier of the client.

blockchainWalletIdstringRequired

The ID of the blockchain wallet to reject

Responses
post
/simulate/clients/{clientId}/blockchain-wallets/{blockchainWalletId}/rejected

No content

Simulate the approval of an onboarding.

post
/simulate/clients/{clientId}/onboarding/approved

Simulate the approval of an onboarding for a manager's client. The client must be in the ONBOARDING_UNDER_REVIEW status and will transit to the WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE status. The client will need to sign the terms and conditions before being able to trade. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
clientIdstringRequired

The unique identifier of the client.

Responses
post
/simulate/clients/{clientId}/onboarding/approved

No content

Simulate the rejection of an onboarding.

post
/simulate/clients/{clientId}/onboarding/rejected

Simulate the rejection of an onboarding for a manager's client. The client must be in the ONBOARDING_UNDER_REVIEW status and will transit to the RESUBMISSION_REQUIRED status. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
clientIdstringRequired

The unique identifier of the client.

Body
reasonstringRequired

The reason why the onboarding has been rejected

Responses
post
/simulate/clients/{clientId}/onboarding/rejected

No content

Simulate the signing of the terms and conditions.

post
/simulate/clients/{clientId}/onboarding/terms-and-conditions/signed

Simulate the signing of the terms and conditions for a manager's client. The client must be in the WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE status and will transit to the VERIFIED status. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
clientIdstringRequired

The unique identifier of the client.

Responses
post
/simulate/clients/{clientId}/onboarding/terms-and-conditions/signed

No content

Simulate the voiding of the current terms and conditions signature process.

post
/simulate/clients/{clientId}/onboarding/terms-and-conditions/voided

Simulate the voiding of the current terms and conditions signature process for a manager's client. The client must be in the WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE status. A signature process will need to be started again. Only available on staging environment.

Authorizations
RIALTO_API_KEYstringRequired
Path parameters
clientIdstringRequired

The unique identifier of the client.

Responses
post
/simulate/clients/{clientId}/onboarding/terms-and-conditions/voided

No content

Last updated