Transactions

Returns the list of all transactions

get

/transactions

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

RIALTO_API_KEYstringRequired

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

hasNextPagebooleanOptional

Whether there are more transactions to fetch with the provided parameters.

400

The request is invalid.

application/json

401

Invalid API key

500

An unexpected error occurred.

get

/transactions

GET /api/manager/v1/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
}

Get a transaction

get

/transactions/{transactionId}

Get a transaction by unique identifier.

Authorizations

RIALTO_API_KEYstringRequired

Path parameters

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

idstring · uuidOptional

The unique identifier of the transaction.

transactionTypestring · enumOptional

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:

statusstring · enumOptional

The status of the transaction. Possible values are:

IDLE: The transaction has been created and is waiting for the initial funds transfer to be initiated,
INITIATED: transaction has been initiated, it is in progress of resolution by Rialto,
COMPLETED: The transaction has been completed,
CANCELLED: The transaction has been cancelled,
DISMISSED: The transaction has been dismissed by Rialto.

Possible values:

idempotencyKeystring · nullableOptional

The idempotency key input at the transaction creation. It is only defined for transactions created by the API

originalAmountnumber · floatOptional

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

fiatCurrencystringOptional

The fiat currency of the transaction. See the list of supported fiat currencies.

blockchainAssetstringOptional

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

blockchainNetworkstringOptional

The blockchain network of the transaction. See the list of supported blockchains.

blockchainWalletIdstring · uuidOptional

The blockchain wallet identifier of transaction.

bankAccountIdstring · uuidOptional

The bank account identifier of transaction. The fiat currency of the transaction is the one of the bank account.

wireReferenceOverridestring · nullableOptional

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.

createdAtstring · date-timeOptional

The creation date of the transaction.

cancelledAtstring · nullableOptional

The date when the transaction was cancelled. Only present if the transaction was cancelled, i.e. in status CANCELLED.

clientIdstring · uuidOptional

The unique identifier of the client.

clientTypestring · enumOptional

The type of the client.

INDIVIDUAL: The client is an individual.
ENTITY: The client is an entity.

Possible values:

401

Invalid API key

404

The transaction is not found.

500

An unexpected error occurred.

get

/transactions/{transactionId}

GET /api/manager/v1/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"
}

PreviousClient transactions NextManager preset fees

Last updated 8 months ago

hashtagReturns the list of all transactions

hashtagGet a transaction

Returns the list of all transactions

Get a transaction