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. Manager API reference

Client bank accounts

PreviousClients onboardingNextClient blockchain wallets

Returns a bank account by ID.

get

Returns a bank account by its unique identifier.

Authorizations
Path parameters
clientIdstring · uuidRequired

The unique identifier of the client.

bankAccountIdstring · uuidRequired

The unique identifier of the bank account.

Responses
200
A bank account.
application/json
401
Invalid API key
404
Bank account not found.
500
An unexpected error occurred.
get
GET /api/manager/v1/clients/{clientId}/bank-accounts/{bankAccountId} HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*
{
  "id": "4be0fab5-d71c-4498-96bb-41c47080430e",
  "label": "Main",
  "fiatCurrency": "eur",
  "countryCode": "FR",
  "type": "PERSONAL",
  "identifiers": {
    "type": "IBAN",
    "iban": "FR1420041010050500013M02606",
    "bic": "BDFEFRPPXXX"
  },
  "thirdPartyBankAccountOwnerName": null,
  "thirdPartyBankAccountOwnerAddress": null,
  "thirdPartyBankAccountOwnerCity": null,
  "thirdPartyBankAccountOwnerPostalCode": null,
  "thirdPartyBankAccountOwnerCountryCode": null,
  "thirdPartyBankAccountOwnerDocuments": null,
  "createdAt": "2024-12-01T09:07:54.940Z",
  "approvedAt": "2024-12-01T14:42:12.045Z",
  "deletedAt": null
}

Deletes a bank account by ID.

delete

Deletes a bank account by its unique identifier. A deleted bank account will still be returned in the list of bank accounts of the client or queriable by ID, but it will have a non null deletedAt field. A deleted bank account can not be used in transactions. This route is only available for verified clients. Unverified clients will receive a 400 error.

Authorizations
Path parameters
clientIdstring · uuidRequired

The unique identifier of the client.

bankAccountIdstring · uuidRequired

The unique identifier of the bank account.

Responses
200
The bank account has been deleted.
application/json
400
The request is invalid.
application/json
401
Invalid API key
404
Bank account not found.
500
An unexpected error occurred.
delete
DELETE /api/manager/v1/clients/{clientId}/bank-accounts/{bankAccountId} HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*
{
  "id": "4be0fab5-d71c-4498-96bb-41c47080430e",
  "label": "Main",
  "fiatCurrency": "eur",
  "countryCode": "FR",
  "type": "PERSONAL",
  "identifiers": {
    "format": "IBAN",
    "iban": "FR1420041010050500013M02606",
    "bic": "BDFEFRPPXXX"
  },
  "thirdPartyBankAccountOwnerName": null,
  "thirdPartyBankAccountOwnerAddress": null,
  "thirdPartyBankAccountOwnerCity": null,
  "thirdPartyBankAccountOwnerPostalCode": null,
  "thirdPartyBankAccountOwnerCountryCode": null,
  "thirdPartyBankAccountOwnerDocuments": null,
  "createdAt": "2024-12-01T09:07:54.940Z",
  "approvedAt": "2024-12-01T14:42:12.045Z",
  "deletedAt": "2024-12-25T00:07:54.940Z"
}
  • GETReturns the list of bank accounts of a client.
  • POSTRequest the creation of a bank account.
  • GETReturns a bank account by ID.
  • DELETEDeletes a bank account by ID.

Returns the list of bank accounts of a client.

get

The bank accounts are sorted by creation date, in descending order. The most recently created bank accounts appear first.

Authorizations
Path parameters
clientIdstring · uuidRequired

The unique identifier of the client.

Responses
200
A JSON array of bank accounts.
application/json
401
Invalid API key
500
An unexpected error occurred.
get
GET /api/manager/v1/clients/{clientId}/bank-accounts HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*
[
  {
    "id": "4be0fab5-d71c-4498-96bb-41c47080430e",
    "label": "Main",
    "fiatCurrency": "eur",
    "countryCode": "FR",
    "type": "PERSONAL",
    "identifiers": {
      "type": "IBAN",
      "iban": "FR1420041010050500013M02606",
      "bic": "BDFEFRPPXXX"
    },
    "thirdPartyBankAccountOwnerName": null,
    "thirdPartyBankAccountOwnerAddress": null,
    "thirdPartyBankAccountOwnerCity": null,
    "thirdPartyBankAccountOwnerPostalCode": null,
    "thirdPartyBankAccountOwnerCountryCode": null,
    "thirdPartyBankAccountOwnerDocuments": null,
    "createdAt": "2024-12-01T09:07:54.940Z",
    "approvedAt": "2024-12-01T14:42:12.045Z",
    "deletedAt": null
  }
]

Request the creation of a bank account.

post

Creates a bank account with the specified parameters. The bank account is created in a pending state and must be approved by an administrator before it can be used in transactions. This route is only available for verified clients. Unverified clients will receive a 400 error.

Authorizations
Path parameters
clientIdstring · uuidRequired

The unique identifier of the client.

Body
labelstring | nullOptional

The label of the bank account.

fiatCurrencystringRequired

The fiat currency of the bank account. See the list of supported fiat currencies.

countryCodestringRequired

The country code of the bank account.

typestring · enumRequired

The type of the bank account. Possible values are:

  • PERSONAL: The bank account is owned by the user,
  • THIRD_PARTY: The bank account is owned by a third party, other than the user.
Possible values:
identifiersone ofRequired

The identifiers of the bank account.

or
or
or
or
or
or
thirdPartyBankAccountOwnerNamestring | nullOptional

The name of the owner of the bank account. Only present if the bank account is of type THIRD_PARTY.

thirdPartyBankAccountOwnerAddressstring | nullOptional

The address of the owner of the bank account. Only present if the bank account is of type THIRD_PARTY.

thirdPartyBankAccountOwnerCitystring | nullOptional

The city of the owner of the bank account. Only present if the bank account is of type THIRD_PARTY.

thirdPartyBankAccountOwnerPostalCodestring | nullOptional

The postal code of the owner of the bank account. Only present if the bank account is of type THIRD_PARTY.

thirdPartyBankAccountOwnerCountryCodestring | nullOptional

The country code of the owner of the bank account. Only present if the bank account is of type THIRD_PARTY.

thirdPartyBankAccountOwnerDocumentsarray | nullOptional

The filenames of the documents of the owner of the bank account. The documents must be uploaded before creating the bank account. Only present if the bank account is of type THIRD_PARTY.

Responses
201
The bank account has been created.
application/json
400
The request is invalid.
application/json
401
Invalid API key
500
An unexpected error occurred.
post
POST /api/manager/v1/clients/{clientId}/bank-accounts HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 412

{
  "label": "Main",
  "fiatCurrency": "eur",
  "countryCode": "FR",
  "type": "PERSONAL",
  "identifiers": {
    "format": "IBAN",
    "iban": "FR1420041010050500013M02606",
    "bic": "BDFEFRPPXXX"
  },
  "thirdPartyBankAccountOwnerName": null,
  "thirdPartyBankAccountOwnerAddress": null,
  "thirdPartyBankAccountOwnerCity": null,
  "thirdPartyBankAccountOwnerPostalCode": null,
  "thirdPartyBankAccountOwnerCountryCode": null,
  "thirdPartyBankAccountOwnerDocuments": null
}
{
  "id": "4be0fab5-d71c-4498-96bb-41c47080430e",
  "label": "Main",
  "fiatCurrency": "eur",
  "countryCode": "FR",
  "type": "PERSONAL",
  "identifiers": {
    "format": "IBAN",
    "iban": "FR1420041010050500013M02606",
    "bic": "BDFEFRPPXXX"
  },
  "thirdPartyBankAccountOwnerName": null,
  "thirdPartyBankAccountOwnerAddress": null,
  "thirdPartyBankAccountOwnerCity": null,
  "thirdPartyBankAccountOwnerPostalCode": null,
  "thirdPartyBankAccountOwnerCountryCode": null,
  "thirdPartyBankAccountOwnerDocuments": null,
  "createdAt": "2024-12-01T09:07:54.940Z",
  "approvedAt": null,
  "deletedAt": null
}