LogoLogo
  • Getting started
    • Overview
    • Quick start
    • Integration
  • Products
    • Fiat <> Crypto conversions
    • Third Party Payments
    • Segregated Accounts
  • Concepts
    • Authentication
    • Idempotency
    • Onboarding
    • Fees and Limits
    • Accounts
      • Client Accounts
      • Manager Accounts
    • Bank Accounts and Wallet Addresses
    • Supported Fiat Currencies, Blockchain Assets and Blockchain Networks
    • Webhooks
    • Document Management
  • Client API reference
    • Transactions
    • Preset fees
    • Deposit instructions
    • Bank accounts
    • Blockchain wallets
    • User
    • Uploads (temporary storage)
    • Documents (permanent storage)
    • Constants
    • Simulate
    • Models
  • Client Specification
  • Manager API reference
    • Clients
    • Clients onboarding
    • Client bank accounts
    • Client blockchain wallets
    • Client preset fees
    • Client deposit instructions
    • Client transactions
    • Transactions
    • Manager preset fees
    • Deposit instructions
    • Uploads (temporary storage)
    • Documents (permanent storage)
    • Webhooks
    • Constants
    • Simulate
    • Models
  • Manager Specification
Powered by GitBook
On this page
  1. Client API reference

Simulate

PreviousConstantsNextModels

Simulate the deletion of a preset fee.

post

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

Authorizations
Path parameters
presetFeeIdstringRequired

The ID of the preset fee to delete

Responses
200
The fee has been deleted.
401
Invalid API key
500
An unexpected error occurred.
post
POST /api/client/v1/simulate/preset-fees/{presetFeeId}/deleted HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

No content

Simulate the approval of a bank account.

post

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

Authorizations
Path parameters
bankAccountIdstringRequired

The ID of the bank account to approve

Responses
200
The bank account has been approved.
application/json
400
The request is invalid
application/json
401
Invalid API key
404
Bank account not found
500
An unexpected error occurred.
post
POST /api/client/v1/simulate/bank-accounts/{bankAccountId}/approved HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

{
  "id": "644ea36b-dd03-420f-add2-71b3f78fde8f"
}

Simulate the rejection of a bank account.

post

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

Authorizations
Path parameters
bankAccountIdstringRequired

The ID of the bank account to reject

Responses
204
The bank account has been rejected.
400
The request is invalid
application/json
401
Invalid API key
404
Bank account not found
500
An unexpected error occurred.
post
POST /api/client/v1/simulate/bank-accounts/{bankAccountId}/rejected HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

No content

Simulate the approval of a blockchain wallet.

post

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

Authorizations
Path parameters
blockchainWalletIdstringRequired

The ID of the blockchain wallet to approve

Responses
200
The blockchain wallet has been approved.
application/json
400
The request is invalid
application/json
401
Invalid API key
404
Blockchain wallet not found
500
An unexpected error occurred.
post
POST /api/client/v1/simulate/blockchain-wallets/{blockchainWalletId}/approved HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

{
  "id": {
    "id": "644ea36b-dd03-420f-add2-71b3f78fde8f"
  }
}

Simulate the rejection of a blockchain wallet.

post

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

Authorizations
Path parameters
blockchainWalletIdstringRequired

The ID of the blockchain wallet to reject

Responses
204
The blockchain wallet has been rejected.
400
The request is invalid
application/json
401
Invalid API key
404
Blockchain wallet not found
500
An unexpected error occurred.
post
POST /api/client/v1/simulate/blockchain-wallets/{blockchainWalletId}/rejected HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

No content
  • POSTSimulate the update of the limit.
  • POSTSimulate the creation of a preset fee.
  • POSTSimulate the deletion of a preset fee.
  • POSTSimulate the initiation of a transaction.
  • POSTSimulate the completion of a transaction.
  • POSTSimulate the dismissal of a transaction.
  • POSTSimulate the approval of a bank account.
  • POSTSimulate the rejection of a bank account.
  • POSTSimulate the approval of a blockchain wallet.
  • POSTSimulate the rejection of a blockchain wallet.

Simulate the update of the limit.

post

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

Authorizations
Body
limitnumberRequired

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

Responses
200
The limit has been updated.
401
Invalid API key
500
An unexpected error occurred.
post
POST /api/client/v1/simulate/limit/updated HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "limit": 10000
}
No content

Simulate the creation of a preset fee.

post

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

Authorizations
Body
one ofOptional
or
Responses
201
The limit has been updated.
401
Invalid API key
500
An unexpected error occurred.
post
POST /api/client/v1/simulate/preset-fees/created HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "transactionType": "OFFRAMP",
  "fiatFeeGroup": "USD",
  "blockchainFeeGroup": "USD_STABLECOIN",
  "type": "FLAT",
  "fee": 125
}
No content

Simulate the initiation of a transaction.

post

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
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
POST /api/client/v1/simulate/transactions/{transactionId}/initiated HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "transactionHashOrWireTransferReference": "ABC123"
}

Simulate the completion of a transaction.

post

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
Path parameters
transactionIdstringRequired

The ID of the transaction to complete

Body
conversionRatenumberRequired

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

post
POST /api/client/v1/simulate/transactions/{transactionId}/completed HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "conversionRate": 1.123456
}

Simulate the dismissal of a transaction.

post

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
Path parameters
transactionIdstringRequired

The ID of the transaction to dismiss

Body
reasonnumberRequired

The reason to dismiss the transaction.

Responses
201
The transaction has been dismissed.
401
Invalid API key
500
An unexpected error occurred.
post
POST /api/client/v1/simulate/transactions/{transactionId}/dismissed HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "reason": "a very good reason"
}
No content