Transactions | Rialto API

Get a transaction

get

Get a transaction by unique identifier.

Authorizations

Path parameters

transactionIdstringrequired

The transaction ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.rialtobridge.xyz/api/client/v1/transactions/{transactionId}' \
  --header 'RIALTO_API_KEY: YOUR_API_KEY'

200

401

404

500

{
  "id": "f7e35a91-53ae-4b8b-b629-9ae047777e06",
  "transactionType": "ONRAMP",
  "status": "IDLE",
  "idempotencyKey": "77d78db6-cb4f-4e8d-8bb4-56bd67198af2",
  "originalAmount": 2398,
  "fiatCurrency": "eur",
  "blockchainAsset": "eurc",
  "blockchainNetwork": "ethereum",
  "blockchainWalletId": "0a5c25ab-2a92-4810-93cf-ab92bbf2240d",
  "bankAccountId": "d2b9dd72-14e7-4b6e-b0d7-f6afe4beb750",
  "additionalDetails": {
    "sourceOfFundsDocuments": [],
    "businessJustificationDocuments": [],
    "comments": "This is a comment"
  },
  "initiationInstruction": {
    "blockchainWallet": null,
    "bankAccount": {
      "countryCode": "DE",
      "iban": "DE89370400440532013000",
      "bic": "COBADEFFXXX",
      "intermediaryBic": "COBADEFF",
      "beneficiary": {
        "name": "John Doe",
        "address": "123 Main Street",
        "city": "Berlin",
        "postcode": "10115",
        "countryCode": "DE"
      }
    },
    "wireReference": "R/ON/C96bjPYxIIJOo3fqz79u"
  },
  "createdAt": "2024-12-08T08:07:12.640Z",
  "initiation": null,
  "completion": null,
  "cancelledAt": null,
  "dismissal": null,
  "clientId": "569fd88c-20a4-46c4-b8c3-328806cc12a4",
  "clientType": "INDIVIDUAL"
}

The transaction

Returns the list of transactions

get

The transactions are sorted by creation date, in descending order. The most recently created transactions appear first. The transactions can be filtered by date using the from and to parameters. If the from and to parameters are not provided, the transactions are fetched from the beginning until now. The transactions can be paginated using the limit parameter. If there are more transactions to fetch with the provided parameters, the response will contain a hasNextPage field set to true. In order to fetch the next page, the to parameter must be set to the createdAt field of the last transaction of the current page.

Authorizations

Query parameters

fromstring · date-timeoptional

The date from which the transactions are fetched. The comparison is made using the createdAt field of the transactions. The comparison is inclusive, meaning that the transactions created at the provided date are included in the result. The value is in ISO 8601 format. If the value is not provided, the transactions are fetched from the beginning.

Example: 2024-12-01T09:07:54.940Z

tostring · date-timeoptional

The date to which the transactions are fetched. The comparison is made using the createdAt field of the transactions. The comparison is exlusive, meaning that the transactions created at the provided date are not included in the result. The value is in ISO 8601 format. If the value is not provided, the transactions are fetched until now.

Example: 2024-12-03T10:07:54.940Z

limitinteger · int32optional

The maximum number of transactions to fetch. The value must be a positive integer. If the value is not provided, the default value is 10. The maximum value is 100.

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.rialtobridge.xyz/api/client/v1/transactions' \
  --header 'RIALTO_API_KEY: YOUR_API_KEY'

200

400

401

500

{
  "items": [
    {
      "id": "1e33e76d-3f80-4dc3-94ba-21980059fc13",
      "transactionType": "OFFRAMP",
      "status": "COMPLETED",
      "idempotencyKey": "d55b2408-5688-4b44-bafa-b15bb2d548ba",
      "originalAmount": 1000.12,
      "fiatCurrency": "usd",
      "blockchainAsset": "usdc",
      "blockchainNetwork": "ethereum",
      "blockchainWalletId": "3c42718a-5b6c-4858-a6b1-2e231deff900",
      "bankAccountId": "4be0fab5-d71c-4498-96bb-41c47080430e",
      "additionalDetails": {
        "sourceOfFundsDocuments": [],
        "businessJustificationDocuments": [],
        "comments": "This is a comment"
      },
      "initiationInstruction": {
        "blockchainWallet": {
          "address": "0x9b7E335088762aD8061C04D08C37902ABC8ACb87",
          "blockchainNetwork": "ethereum"
        },
        "bankAccount": null,
        "wireReference": null
      },
      "createdAt": "2025-01-01T13:30:12.640Z",
      "initiation": {
        "amount": 1000.12,
        "bpsFee": 125,
        "timestamp": "2025-01-01T14:10:56.110Z"
      },
      "completion": {
        "amount": 987.61,
        "conversionRate": 1,
        "volumeConsumption": 1000.12,
        "transactionHash": null,
        "wireReference": "R/OF/C96bjPYxIIJOo3fqz79u",
        "timestamp": "2025-01-01T15:25:08.310Z"
      },
      "cancelledAt": null,
      "dismissal": null,
      "clientId": "569fd88c-20a4-46c4-b8c3-328806cc12a4",
      "clientType": "INDIVIDUAL"
    },
    {
      "id": "f7e35a91-53ae-4b8b-b629-9ae047777e06",
      "transactionType": "ONRAMP",
      "status": "IDLE",
      "idempotencyKey": "77d78db6-cb4f-4e8d-8bb4-56bd67198af2",
      "originalAmount": 2398,
      "fiatCurrency": "eur",
      "blockchainAsset": "eurc",
      "blockchainNetwork": "ethereum",
      "blockchainWalletId": "0a5c25ab-2a92-4810-93cf-ab92bbf2240d",
      "bankAccountId": "d2b9dd72-14e7-4b6e-b0d7-f6afe4beb750",
      "additionalDetails": {
        "sourceOfFundsDocuments": [],
        "businessJustificationDocuments": [],
        "comments": "This is a comment"
      },
      "initiationInstruction": {
        "blockchainWallet": null,
        "bankAccount": {
          "countryCode": "DE",
          "iban": "DE89370400440532013000",
          "bic": "COBADEFFXXX",
          "intermediaryBic": "COBADEFF",
          "beneficiary": {
            "name": "John Doe",
            "address": "123 Main Street",
            "city": "Berlin",
            "postcode": "10115",
            "countryCode": "DE"
          }
        },
        "wireReference": "R/ON/C96bjPYxIIJOo3fqz79u"
      },
      "createdAt": "2024-12-08T08:07:12.640Z",
      "initiation": null,
      "completion": null,
      "cancelledAt": null,
      "dismissal": null,
      "clientId": "569fd88c-20a4-46c4-b8c3-328806cc12a4",
      "clientType": "INDIVIDUAL"
    }
  ],
  "hasNextPage": false
}

A JSON array of transactions.

Creates a transaction

post

Creates a new transaction on the Rialto platform. The transaction can be either an on-ramp (fiat to blockchain asset) or off-ramp (blockchain asset to fiat) transaction. The transaction is created in status IDLE and is waiting for the initial funds transfer to be initiated.

Authorizations

Header parameters

Idempotency-Keystringrequired

A unique identifier for the request. It is used to ensure that the request is idempotent. The same request with the same idempotency key will return a 409 status.

Body

transactionTypestring · enumrequired

The type of the transaction. Possible values are:

OFFRAMP: The transaction is an off-ramping of blockchain asset to fiat currency,
ONRAMP: The transaction is an on-ramping of fiat currency to blockchain asset.

Available options:

amountnumber · floatrequired

The amount of the transaction. The value is always positive.

blockchainAssetstringrequired

The blockchain asset of the transaction. See the list of supported blockchain assets.

bankAccountIdstring · uuidrequired

The identifier of the selected bank account for the transaction.

blockchainWalletIdstring · uuidrequired

The identifier of the selected blockchain wallet for the transaction

sourceOfFundsDocumentsstring[]optional

The filenames of the documents related to the source of funds of the transaction. The documents must be uploaded before submitting the onboarding. Field is optional.

businessJustificationDocumentsstring[]optional

The filenames of the documents related to the business justification of the transaction. The documents must be uploaded before submitting the onboarding. Field is optional.

commentsstringoptional

Comments added by the user at the creation of the transaction. Field is optional.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.rialtobridge.xyz/api/client/v1/transactions' \
  --header 'RIALTO_API_KEY: YOUR_API_KEY' \
  --header 'Idempotency-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "transactionType": "ONRAMP",
    "amount": 2398,
    "blockchainAsset": "eurc",
    "bankAccountId": "d2b9dd72-14e7-4b6e-b0d7-f6afe4beb750",
    "blockchainWalletId": "0a5c25ab-2a92-4810-93cf-ab92bbf2240d",
    "sourceOfFundsDocuments": [],
    "businessJustificationDocuments": [],
    "comments": "This is a comment"
  }'

201

400

401

409

500

{
  "id": "f7e35a91-53ae-4b8b-b629-9ae047777e06",
  "transactionType": "ONRAMP",
  "status": "IDLE",
  "idempotencyKey": "77d78db6-cb4f-4e8d-8bb4-56bd67198af2",
  "originalAmount": 2398,
  "fiatCurrency": "eur",
  "blockchainAsset": "eurc",
  "blockchainNetwork": "ethereum",
  "blockchainWalletId": "0a5c25ab-2a92-4810-93cf-ab92bbf2240d",
  "bankAccountId": "d2b9dd72-14e7-4b6e-b0d7-f6afe4beb750",
  "additionalDetails": {
    "sourceOfFundsDocuments": [],
    "businessJustificationDocuments": [],
    "comments": "This is a comment"
  },
  "initiationInstruction": {
    "blockchainWallet": null,
    "bankAccount": {
      "countryCode": "DE",
      "iban": "DE89370400440532013000",
      "bic": "COBADEFFXXX",
      "intermediaryBic": "COBADEFF",
      "beneficiary": {
        "name": "John Doe",
        "address": "123 Main Street",
        "city": "Berlin",
        "postcode": "10115",
        "countryCode": "DE"
      }
    },
    "wireReference": "R/ON/C96bjPYxIIJOo3fqz79u"
  },
  "createdAt": "2024-12-08T08:07:12.640Z",
  "initiation": null,
  "completion": null,
  "cancelledAt": null,
  "dismissal": null,
  "clientId": "569fd88c-20a4-46c4-b8c3-328806cc12a4",
  "clientType": "INDIVIDUAL"
}

The transaction has been created.