# Ripple Mint API

API operations for programmatic integration with Ripple Mint.

Covers transaction queries for issuance, redemption and bridge activity; the fiat instructions
that bind a payment memo to an incoming wire, along with the Ripple bank account to send it to;
the wallets and cash accounts registered against your stablecoin product; the Ripple-owned
on-chain destinations you redeem to; and public market cap endpoints for RLUSD supply data.


Version: 1.0.0

## Servers

```
https://api.ripple.com
```

## Security

### oauth2

Type: oauth2
Token URL: https://api.ripple.com/v2/oauth/token
Scopes:
- `rlusd_customers:read`: Read transactions, fiat instructions, bank details, wallets, bank accounts and crypto instructions
- `rlusd_customers:write`: Approve pending redemptions, and create or delete fiat buy instructions

## Download OpenAPI description

 - [Ripple Mint API](https://docs.ripple.com/_bundle/@l10n/pt-BR/products/stablecoin/api/reference/rlusd-openapi.yaml)

## Authentication

 - [POST /v2/oauth/token](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/authentication/getaccesstoken.md): OAuth 2.0 Client Credentials grant. Returns a Bearer token valid for 1 hour. Credentials may be passed in the request body or via HTTP Basic Auth header.
## Transactions

 - [GET /v1/stablecoin/transactions](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/transactions/listtransactions.md): Returns a paginated list of transactions, optionally filtered by types and statuses.
 - [GET /v1/stablecoin/transactions/{id}](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/transactions/gettransaction.md): Returns a single transaction by ID.
 - [PUT /v1/stablecoin/transactions/{id}/destination](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/transactions/updatetransactiondestination.md): Approves a transaction held in `PENDING` status (flexible redemption) and directs it. Set `type` to `FIAT` to settle to your default bank account (creates a `REDEMPTION`), or to `CRYPTO` with a `walle
## Fiat instructions

 - [GET /v1/stablecoin/fiat-bank-details](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/fiat-instructions/getfiatbankdetails.md): Returns the Ripple bank account to wire fiat to when buying stablecoin - the same object embedded as `bankDetails` on every fiat instruction, served on its own. The bank belongs to your account rather
 - [GET /v1/stablecoin/fiat-instructions](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/fiat-instructions/listfiatinstructions.md): Returns a paginated list of your fiat instructions, both buy (`CRYPTO` destination) and redemption (`FIAT` destination). Deleted instructions are excluded. `bankDetails` is identical on every instruct
 - [PUT /v1/stablecoin/fiat-instructions/{id}](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/fiat-instructions/createfiatinstruction.md): Declares an incoming fiat payment under an id you choose, and returns the `memo` to quote in that payment's reference field so the funds can be attributed and the RLUSD minted to the wallet you named.
 - [GET /v1/stablecoin/fiat-instructions/{id}](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/fiat-instructions/getfiatinstruction.md): Returns a single fiat instruction by id, including its `memo` and current `status`. Works for both buy and redemption instructions belonging to your account. Only your own instructions are visible. An
 - [DELETE /v1/stablecoin/fiat-instructions/{id}](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/fiat-instructions/deletefiatinstruction.md): Retires a buy instruction you no longer intend to use, so a fiat payment arriving later with its memo can never mint against it. Because instructions never expire, this is the only way to retire an un
## Wallets

 - [GET /v1/stablecoin/wallets](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/wallets/listwallets.md): Returns a paginated list of the wallets registered for your tenant. This is the `ripId` lookup: use it to resolve the `walletRipId` you quote on a fiat buy instruction or a bridge approval, and to map
## Bank accounts

 - [GET /v1/stablecoin/bank-accounts](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/bank-accounts/listbankaccounts.md): Returns a paginated list of the cash accounts registered against your stablecoin product, including which one your `FIAT` redemptions settle to (`isRedemption`). Account numbers and IBANs are served r
## Crypto instructions

 - [GET /v1/stablecoin/crypto-instructions](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/crypto-instructions/listcryptoinstructions.md): Returns the distinct Ripple-owned on-chain destinations to which the authenticated tenant sends RLUSD for redemption/bridging. An empty or cold cache returns an empty page with `200 OK`.
## Market Cap

 - [GET /v1/stablecoin/market-cap/{currencyCode}/total](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/market-cap/getmarketcaptotal.md): Returns the total RLUSD supply (all issued tokens, regardless of circulating status) with a per-chain breakdown. No authentication required.
 - [GET /v1/stablecoin/market-cap/{currencyCode}/total/amount](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/market-cap/getmarketcaptotalamount.md): Returns the total RLUSD supply as a plain decimal string (e.g. `"1000000000.00"`). Useful for lightweight integrations that only need the aggregate figure. No authentication required.
 - [GET /v1/stablecoin/market-cap/{currencyCode}/circulating](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/market-cap/getmarketcapcirculating.md): Returns the circulating RLUSD supply with a per-chain breakdown. Returns `404` if the circulating supply API is not enabled. No authentication required.
 - [GET /v1/stablecoin/market-cap/{currencyCode}/circulating/amount](https://docs.ripple.com/pt-br/products/stablecoin/api/reference/rlusd-openapi/market-cap/getmarketcapcirculatingamount.md): Returns the circulating RLUSD supply as a plain decimal string. Returns `404` if the circulating supply API is not enabled. No authentication required.
