Guides

Resources

Explore the resources used by the StablR API.

Suggest Edits

The StablR API consists out of several functions that enable you to programmatically on-ramp and off-ramp EURR as well as manage your wallets.

This page contains information on the following resources:

  • Order Object
  • Transfer Object
  • Wallets Object

Core Resources

Order Objects

The order objects represent:

  • The initiated order from a customer to buy or sell EURR; and
  • The order details from an initiated order to buy or sell EURR.

Example Orders Objects

{
  "Type": "Buy",
  "Amount": "{AMOUNT}",
  "WalletId": "{WALLET_ID}",
  "CustomerReference": "OPTIONAL"
}

{
  "OrderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Type": "Buy",
  "Amount": {AMOUNT},
  "WalletId": "2fa85f64-5717-4562-b3fc-2c963f66afa5",
  "CustomerReference": "OPTIONAL",
  "Status": "Completed",
  "FiatTransferId": "4fa85f64-5717-4562-b3fc-2c963f66afa7",
  "CryptoTransferId": "",
  "CreatedAt": "2024-05-30T08:58:16.730Z"
}

Orders Attributes

OrderId string
A UUID for the order.

Type enum
The type of order indicates the direction of the order. A buy order constitutes the conversion of fiat funds into EURR, and a sell order constitutes the redemption of EURR into fiat funds.

Amount string
The monetary value to be issued or redeemed by the issuer of EURR.

WalletId string
A UUID for the wallet.

CustomerReference string
An optional data string that the customer can use to provide an order with an internal reference note.

Status string
Status of the order. Pending indicates that the order is in progress, Completed indicates it is finished, and Failed indicates the order has failed.

FiatTransferId string
The Id for the order's corresponding fiat transfer details. This parameter is returned when Type = Buy.

CryptoTransferId string
The Id for the order's corresponding crypto transfer details. This parameter is returned when Type = Sell.

CreatedAt string
ISO-8601 UTC date/time format.

Transfer Objects

The transfer objects represent:

  • The transfer details for fiat funds to enable the customer in transferring fiat with its business bank account to StablR's bank account; or
  • The transfer details for crypto funds to enable the customer in transferring EURR from its whitelisted wallet(s) to StablR's wallet.

Example Transfer Objects

{
  "Id": "4fa85f64-5717-4562-b3fc-2c963f66afa7",
  "OrderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Beneficiary": "StablR Solutions DAC",
  "AccountNumber": "BANK ACCOUNT NUMBER",
  "Amount": {AMOUNT},
  "BankIdentifier": "BIC/SWIFT",
  "BlincId": 0,
  "BankName": "CUSTODIAN BANK",
  "BankAddress": "CUSTODIAN STREET 99",
  "BankPostalCode": "9999",
  "BankCity": "CUSTODIAN CITY",
  "BankCountry": "CUSTODIAN COUNTRY",
  "TransferStatus": "PENDING",
  "CreatedAt": "2024-05-30T08:58:16.730Z"
}

{
  "Id": "4fa85f64-5717-4562-b3fc-2c963f66afa7",
  "OrderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "WalletOwner": "{WALLET_OWNER}",
  "WalletAddress": "{WALLET_ADDRESS}",
  "Amount": "{AMOUNT},
  "CreatedAt": "2024-05-30T09:16:37.250Z"
}

Transfer Attributes

Idstring
A UUID for the transfer instruction details.

OrderId string
A UUID for the transfer's corresponding buy or sell order.

Beneficiary string

The legal name of StablR's the beneficiary bank account holder name.

AccountNumber string
The bank account number of StablR's segregated bank account.

Amount string
The monetary value in fiat or crypto to be transferred to StablR.

BankIdentifier string
The Business Identifier Code (BIC) or SWIFT code is standard format code that identifies the bank that issues StablR's segregated bank account.

BlincId string
StablR's unique account number within the BLINC instant settlement network.

BankName string
The name of the bank that issues StablR's segregated bank account.

BankAddress string
The address of the bank that issues StablR's segregated bank account.

BankPostalCode string
The postal code of the bank that issues StablR's segregated bank account.

BankCity string
The city of the bank that issues StablR's segregated bank account.

BankCountry string
The country of the bank that issues StablR's segregated bank account.

WalletOwner string
The legal name of the issuer of EURR.

WalletAddress string
The destination address of the issuer of EURR for the redemption process.

TransferStatus string
Status of the transfer. Pending indicates that the transfer is in the process of running, Confirmed indicates it is finished, and Failed indicates the transfer failed.

CreatedAt string
ISO-8601 UTC date/time format.


Additional Resources

Wallets Objects

The wallet objects represent:

  • The whitelisted wallet from a customer; and
  • The wallet details from a whitelisted wallet.

Example Wallets Objects

{
  "Name": "{WALLET_NAME}",
  "Type": "MetaMaskInstitutional",
  "Network": "Ethereum",
  "Address": "{WALLET_ADDRESS}"
}

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "{WALLET_NAME}",
  "Type": "MetaMaskInstitutional",
  "Network": "Ethereum",
  "Address": "{WALLET ADDRESS}",
  "Status": "Approved",
  "CreatedAt": "2024-05-30T09:16:37.250Z"
}

Wallets Attributes

Id string
A UUID for the whitelisted wallet.

Name string
The name or alias of a whitelisted wallet within the StablR Account.

Type enum
The type of wallet that is whitelisted (i.e. MetaMask Institutional, Fireblocks, Copper, etc.).

Network enum
The network which supports the whitelisted wallet (Ethereum).

Address string
The data string that identifies a location where digital assets are stored on a public blockchain.

Status string
Status of the whitelisted or removed wallet. Pending indicates that the transfer is in the process of being verified by StablR, Approved indicates the wallet whitelist is finished, Deleted indicates the wallet removal is finished, Rejected indicates the wallet whitelist failed.

CreatedAt string
ISO-8601 UTC date/time format.

Updated 5 months ago

What’s Next