Simulate

Simulate the update of the limit.

post

https://api.rialtobridge.xyz/api/client/v1https://staging.api.rialtobridge.xyz/api/client/v1http://localhost:3002/api/client/v1

/simulate/limit/updated

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

Authorizations

api_key

RIALTO_API_KEYstringRequired

Body

application/json

limitnumberRequired

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

Responses

200

The limit has been updated.

No content

401

Invalid API key

500

An unexpected error occurred.

post

/simulate/limit/updated

HTTPcURLJavaScriptPython

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

https://api.rialtobridge.xyz/api/client/v1https://staging.api.rialtobridge.xyz/api/client/v1http://localhost:3002/api/client/v1

/simulate/preset-fees/created

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

Authorizations

api_key

RIALTO_API_KEYstringRequired

Body

application/json

or

Responses

201

The limit has been updated.

401

Invalid API key

500

An unexpected error occurred.

post

/simulate/preset-fees/created

HTTPcURLJavaScriptPython

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 deletion of a preset fee.

post

https://api.rialtobridge.xyz/api/client/v1https://staging.api.rialtobridge.xyz/api/client/v1http://localhost:3002/api/client/v1

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

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

Authorizations

api_key

RIALTO_API_KEYstringRequired

Path parameters

presetFeeIdstringRequired

The ID of the preset fee to delete

Responses

200

The fee has been deleted.

No content

401

Invalid API key

500

An unexpected error occurred.

post

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

HTTPcURLJavaScriptPython

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 initiation of a transaction.

post

https://api.rialtobridge.xyz/api/client/v1https://staging.api.rialtobridge.xyz/api/client/v1http://localhost:3002/api/client/v1

/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

api_key

RIALTO_API_KEYstringRequired

Path parameters

transactionIdstringRequired

The ID of the transaction to initiate

Body

application/json

transactionHashOrWireTransferReferencestring | nullOptional

The transaction hash or wire transfer reference.

initiationAmountnumberRequired

The amount received in the transaction.

post

/simulate/transactions/{transactionId}/initiated

HTTPcURLJavaScriptPython

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

https://api.rialtobridge.xyz/api/client/v1https://staging.api.rialtobridge.xyz/api/client/v1http://localhost:3002/api/client/v1

/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

api_key

RIALTO_API_KEYstringRequired

Path parameters

transactionIdstringRequired

The ID of the transaction to complete

Body

application/json

conversionRatenumberRequired

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

post

/simulate/transactions/{transactionId}/completed

HTTPcURLJavaScriptPython

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

https://api.rialtobridge.xyz/api/client/v1https://staging.api.rialtobridge.xyz/api/client/v1http://localhost:3002/api/client/v1

/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

api_key

RIALTO_API_KEYstringRequired

Path parameters

transactionIdstringRequired

The ID of the transaction to dismiss

Body

application/json

reasonnumberRequired

The reason to dismiss the transaction.

Responses

201

The transaction has been dismissed.

401

Invalid API key

500

An unexpected error occurred.

post

/simulate/transactions/{transactionId}/dismissed

HTTPcURLJavaScriptPython

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

Simulate the approval of a bank account.

post

https://api.rialtobridge.xyz/api/client/v1https://staging.api.rialtobridge.xyz/api/client/v1http://localhost:3002/api/client/v1

/simulate/bank-accounts/{bankAccountId}/approved

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

Authorizations

api_key

RIALTO_API_KEYstringRequired

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

/simulate/bank-accounts/{bankAccountId}/approved

HTTPcURLJavaScriptPython

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

https://api.rialtobridge.xyz/api/client/v1https://staging.api.rialtobridge.xyz/api/client/v1http://localhost:3002/api/client/v1

/simulate/bank-accounts/{bankAccountId}/rejected

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

Authorizations

api_key

RIALTO_API_KEYstringRequired

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

/simulate/bank-accounts/{bankAccountId}/rejected

HTTPcURLJavaScriptPython

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

https://api.rialtobridge.xyz/api/client/v1https://staging.api.rialtobridge.xyz/api/client/v1http://localhost:3002/api/client/v1

/simulate/blockchain-wallets/{blockchainWalletId}/approved

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

Authorizations

api_key

RIALTO_API_KEYstringRequired

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

/simulate/blockchain-wallets/{blockchainWalletId}/approved

HTTPcURLJavaScriptPython

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

https://api.rialtobridge.xyz/api/client/v1https://staging.api.rialtobridge.xyz/api/client/v1http://localhost:3002/api/client/v1

/simulate/blockchain-wallets/{blockchainWalletId}/rejected

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

Authorizations

api_key

RIALTO_API_KEYstringRequired

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

/simulate/blockchain-wallets/{blockchainWalletId}/rejected

HTTPcURLJavaScriptPython

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