Client transactions

Get transactions of a client

get

The transactions are sorted by creation date, in descending order. The most recently created transactions appears 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

Path parameters

clientIdstringRequired

The unique identifier of the client.

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

200

A JSON array of transactions.

application/json

400

The request is invalid.

application/json

401

Invalid API key

404

The client is not found.

500

An unexpected error occurred.

get

HTTPcURLJavaScriptPython

GET /api/manager/v1/clients/{clientId}/transactions HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

{
  "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",
      "wireReferenceOverride": "azertyuiop28!@#",
      "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,
        "fixedFee": 10,
        "timestamp": "2025-01-01T14:10:56.110Z",
        "transactionHash": "0x185f5efe57fb98fbebda75bb5646c9deff8d5327a89b69f29f70163431de6925",
        "wireReference": null
      },
      "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",
      "wireReferenceOverride": null,
      "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
}

Creates a transaction for a client

post

Creates a new transaction on the Rialto platform for a client. 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

Path parameters

clientIdstringRequired

The unique identifier of the client.

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.

Possible values:

transactionAmountnumber · 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.

wireReferenceOverridestring | nullOptional

In case of offramp, string that will replace the default wire reference. Use for specific cases of matching and integration on the client bank side. Field is optional.

Responses

201

The transaction has been created.

application/json

400

The request is invalid.

application/json

401

Invalid API key

404

User not found.

409

The request has already been processed.

500

An unexpected error occurred.

post

HTTPcURLJavaScriptPython

POST /api/manager/v1/clients/{clientId}/transactions HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Idempotency-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 317

{
  "transactionType": "ONRAMP",
  "transactionAmount": 2398,
  "blockchainAsset": "eurc",
  "bankAccountId": "d2b9dd72-14e7-4b6e-b0d7-f6afe4beb750",
  "blockchainWalletId": "0a5c25ab-2a92-4810-93cf-ab92bbf2240d",
  "sourceOfFundsDocuments": [],
  "businessJustificationDocuments": [],
  "comments": "This is a comment",
  "wireReferenceOverride": null
}

{
  "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",
  "wireReferenceOverride": null,
  "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"
}

Get a transaction of a client

get

Get a transaction of a client by unique identifier.

Authorizations

Path parameters

clientIdstringRequired

The unique identifier of the client.

transactionIdstringRequired

The transaction ID

Query parameters

id_typestring · enumOptional

Defines whether the specified ID is the transaction ID of the transaction hash.

Possible values:

Responses

200

The transaction

application/json

401

Invalid API key

404

The client or the transaction is not found.

500

An unexpected error occurred.

get

HTTPcURLJavaScriptPython

GET /api/manager/v1/clients/{clientId}/transactions/{transactionId} HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

{
  "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",
  "wireReferenceOverride": null,
  "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"
}

Cancel a transaction of a client

post

Cancel a transaction of a client by unique identifier.

Authorizations

Path parameters

clientIdstringRequired

The unique identifier of the client.

transactionIdstringRequired

The transaction ID

Responses

200

The transaction has been cancelled.

application/json

400

The request is invalid.

application/json

401

Invalid API key

404

The client or the transaction is not found.

500

An unexpected error occurred.

post

HTTPcURLJavaScriptPython

POST /api/manager/v1/clients/{clientId}/transactions/{transactionId}/cancel HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

{
  "id": "d4cc6e0e-0045-4d54-befa-0defbaf15e2a",
  "transactionType": "ONRAMP",
  "status": "CANCELLED",
  "idempotencyKey": "8d1d2f07-f458-41d2-8adc-3987c522498f",
  "originalAmount": 1230,
  "fiatCurrency": "eur",
  "blockchainAsset": "eurc",
  "blockchainNetwork": "ethereum",
  "blockchainWalletId": "0a5c25ab-2a92-4810-93cf-ab92bbf2240d",
  "bankAccountId": "d2b9dd72-14e7-4b6e-b0d7-f6afe4beb750",
  "wireReferenceOverride": null,
  "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/Xsyq6Pi6j29q8bbAU2H6"
  },
  "createdAt": "2024-12-01T09:07:54.940Z",
  "initiation": null,
  "completion": null,
  "cancelledAt": "2024-12-01T11:00:38.040Z",
  "dismissal": null,
  "clientId": "569fd88c-20a4-46c4-b8c3-328806cc12a4",
  "clientType": "INDIVIDUAL"
}

Returns a quote for a new transaction

get

Returns a quote for a new transaction on the Rialto platform The quote is an estimation of the amount that the client will receive in the completion of the transaction. The quote is based on the current exchange rate and the client's preset fees.

Authorizations

Path parameters

clientIdstringRequired

The unique identifier of the client.

Query parameters

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.

Example: OFFRAMPPossible values:

transactionAmountnumber · floatRequired

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

Example: 1000.12

bankAccountIdstring · uuidRequired

The identifier of the selected bank account for the transaction.

Example: f086ab63-c037-4726-9292-18760de385b0

blockchainWalletIdstring · uuidRequired

The identifier of the selected blockchain wallet for the transaction.

Example: c05ae486-44bf-4672-99e1-bc45febf66a4

blockchainAssetstringRequired

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

Example: eurc

Responses

200

The quote for the transaction.

application/json

400

The request is invalid.

application/json

401

Invalid API key

404

The client is not found.

500

An unexpected error occurred.

get

HTTPcURLJavaScriptPython

GET /api/manager/v1/clients/{clientId}/transactions/quote HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

{
  "initiationAmount": 1000.12,
  "completionAmount": 990.12,
  "bpsFee": 100,
  "fixedFee": 10,
  "conversionRate": 1,
  "volumeConsumption": 1051.36,
  "remainingPrevisionalVolume": 12345.76,
  "presetFeeId": "e5b47b67-7ef9-45c3-abd3-79eac5551cc4",
  "fiatCurrency": "eur",
  "blockchainAsset": "eurc",
  "blockchainNetwork": "ethereum"
}

Returns the transactions volume breakdown of a client

get

Returns the volume breakdown of the transactions of a client. The summary is returned for the current month. The breakdown for each transaction path is returned for the current month and the current day. The volume is in US dollars. Two decimal places are allowed. The volume is divided according to the status of the transactions:

• IDLE: transaction has been created and is waiting for initiation,

• INITIATED: transaction has been initiated, it is in progress of resolution by Rialto,

• COMPLETED: transaction has been completed.

Authorizations

Path parameters

clientIdstringRequired

The unique identifier of the client.

Responses

200

The transactions volume breakdown.

application/json

401

Invalid API key

404

The client is not found.

500

An unexpected error occurred.

get

HTTPcURLJavaScriptPython

GET /api/manager/v1/clients/{clientId}/transactions/volume HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

{
  "currentMonth": {
    "limit": 100000,
    "remaining": 12345.76,
    "idle": 3310.21,
    "initiated": 2000,
    "completed": 11925.81,
    "total": 17236.01
  },
  "paths": [
    {
      "transactionType": "OFFRAMP",
      "fiatFeeGroup": "USD",
      "blockchainFeeGroup": "USD_STABLECOIN",
      "currentMonth": {
        "idle": 1000,
        "initiated": 2000,
        "completed": 3000,
        "total": 6000
      },
      "currentDay": {
        "idle": 100,
        "initiated": 200,
        "completed": 300,
        "total": 600
      }
    },
    {
      "transactionType": "ONRAMP",
      "fiatFeeGroup": "G10",
      "blockchainFeeGroup": "EUR_STABLECOIN",
      "currentMonth": {
        "idle": 2200,
        "initiated": 0,
        "completed": 8500,
        "total": 10700
      },
      "currentDay": {
        "idle": 220,
        "initiated": 0,
        "completed": 850,
        "total": 1070
      }
    }
  ]
}

Generates a pre-signed URL for downloading the invoice of a completed transaction

post

Generates a pre-signed URL for downloading the invoice of a completed transaction. The invoice is a PDF file containing the details of the transaction. The invoice is generated only for completed transactions. Each pre-signed URL is valid for 5 minutes. See the S3 documentation for more information on S3 pre-signed URLs.

Authorizations

Path parameters

clientIdstringRequired

The unique identifier of the client.

transactionIdstringRequired

The transaction ID

Responses

201

The pre-signed URL for downloading the invoice.

application/json

400

The request is invalid.

application/json

401

Invalid API key

404

The account or the transaction is not found.

500

An unexpected error occurred.

post

HTTPcURLJavaScriptPython

POST /api/manager/v1/clients/{clientId}/transactions/{transactionId}/request-invoice HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

{
  "preSignedUrl": "https://rialtobridge-invoices.s3.amazonaws.com/transaction-invoice.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJ2ZJZ6JZJZJZJZJZ%2F20220301%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20220301T000000Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
}