Bank accounts

Returns the list of bank accounts.

get

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

/bank-accounts

The bank accounts are sorted by creation date, with the most recent bank accounts appearing first.

Authorizations

api_key

RIALTO_API_KEYstringRequired

Responses

200

A JSON array of bank accounts.

application/json

idstring · uuidOptional

The unique identifier of the bank account.

labelstring · nullableOptional

The label of the bank account.

fiatCurrencystringOptional

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

countryCodestringOptional

The country code of the bank account. See the list of supported country codes.

typestring · enumOptional

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 ofOptional

The identifiers of the bank account.

or

or

or

or

or

or

thirdPartyBankAccountOwnerNamestring · nullableOptional

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

thirdPartyBankAccountOwnerAddressstring · nullableOptional

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

thirdPartyBankAccountOwnerCitystring · nullableOptional

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

thirdPartyBankAccountOwnerPostalCodestring · nullableOptional

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

thirdPartyBankAccountOwnerCountryCodestring · nullableOptional

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

thirdPartyBankAccountOwnerDocumentsstring[] · nullableOptional

The keys of the documents of the owner of the bank account. Each key can be used in order to download the document. Only present if the bank account is of type THIRD_PARTY.

createdAtstring · date-timeOptional

The creation date of the bank account.

approvedAtstring · nullableOptional

The date when the bank account was approved. Only present if the bank account was approved.

deletedAtstring · nullableOptional

The date when the bank account was deleted. Only present if the bank account was deleted.

401

Invalid API key

500

An unexpected error occurred.

get

/bank-accounts

HTTPcURLJavaScriptPython

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

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

/bank-accounts

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

api_key

RIALTO_API_KEYstringRequired

Body

application/json

labelstring · nullableOptional

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 · nullableOptional

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

thirdPartyBankAccountOwnerAddressstring · nullableOptional

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

thirdPartyBankAccountOwnerCitystring · nullableOptional

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

thirdPartyBankAccountOwnerPostalCodestring · nullableOptional

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

thirdPartyBankAccountOwnerCountryCodestring · nullableOptional

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

thirdPartyBankAccountOwnerDocumentsstring[] · nullableOptional

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

/bank-accounts

HTTPcURLJavaScriptPython

POST /api/client/v1/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
}

Returns a bank account by ID.

get

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

/bank-accounts/{bankAccountId}

Returns a bank account by its unique identifier.

Authorizations

api_key

RIALTO_API_KEYstringRequired

Path parameters

bankAccountIdstring · uuidRequired

The unique identifier of the bank account.

Responses

200

A bank account.

application/json

idstring · uuidOptional

The unique identifier of the bank account.

labelstring · nullableOptional

The label of the bank account.

fiatCurrencystringOptional

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

countryCodestringOptional

The country code of the bank account. See the list of supported country codes.

typestring · enumOptional

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 ofOptional

The identifiers of the bank account.

or

or

or

or

or

or

thirdPartyBankAccountOwnerNamestring · nullableOptional

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

thirdPartyBankAccountOwnerAddressstring · nullableOptional

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

thirdPartyBankAccountOwnerCitystring · nullableOptional

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

thirdPartyBankAccountOwnerPostalCodestring · nullableOptional

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

thirdPartyBankAccountOwnerCountryCodestring · nullableOptional

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

thirdPartyBankAccountOwnerDocumentsstring[] · nullableOptional

The keys of the documents of the owner of the bank account. Each key can be used in order to download the document. Only present if the bank account is of type THIRD_PARTY.

createdAtstring · date-timeOptional

The creation date of the bank account.

approvedAtstring · nullableOptional

The date when the bank account was approved. Only present if the bank account was approved.

deletedAtstring · nullableOptional

The date when the bank account was deleted. Only present if the bank account was deleted.

401

Invalid API key

404

Bank account not found.

500

An unexpected error occurred.

get

/bank-accounts/{bankAccountId}

HTTPcURLJavaScriptPython

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

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

/bank-accounts/{bankAccountId}

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

api_key

RIALTO_API_KEYstringRequired

Path parameters

bankAccountIdstring · uuidRequired

The unique identifier of the bank account.

Responses

200

The bank account has been deleted.

application/json

idstring · uuidOptional

The unique identifier of the bank account.

labelstring · nullableOptional

The label of the bank account.

fiatCurrencystringOptional

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

countryCodestringOptional

The country code of the bank account. See the list of supported country codes.

typestring · enumOptional

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 ofOptional

The identifiers of the bank account.

or

or

or

or

or

or

thirdPartyBankAccountOwnerNamestring · nullableOptional

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

thirdPartyBankAccountOwnerAddressstring · nullableOptional

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

thirdPartyBankAccountOwnerCitystring · nullableOptional

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

thirdPartyBankAccountOwnerPostalCodestring · nullableOptional

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

thirdPartyBankAccountOwnerCountryCodestring · nullableOptional

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

thirdPartyBankAccountOwnerDocumentsstring[] · nullableOptional

The keys of the documents of the owner of the bank account. Each key can be used in order to download the document. Only present if the bank account is of type THIRD_PARTY.

createdAtstring · date-timeOptional

The creation date of the bank account.

approvedAtstring · nullableOptional

The date when the bank account was approved. Only present if the bank account was approved.

deletedAtstring · nullableOptional

The date when the bank account was deleted. Only present if the bank account was deleted.

400

The request is invalid.

application/json

401

Invalid API key

404

Bank account not found.

500

An unexpected error occurred.

delete

/bank-accounts/{bankAccountId}

HTTPcURLJavaScriptPython

DELETE /api/client/v1/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"
}