A+ API
API Reference
Browse all endpoints: mint, burn, and transfer.
Try the API
Use the interactive playground to send requests (requires an API token).
Mint, Burn, and Transfer flows
The API supports three flows: mint (fiat → token), burn (token → fiat), and transfer (token only). Note that the wallet provider will add thenonce, from, gasPrice and gasLimit.
Mint route
- Issuing bank determines they have sufficient funds (e.g. from an incoming wire) to mint USDA+ to a specified address
- Bank calls our API to get the
mint()payload (amount and recipient based on those funds, minus fees) - Bank calls their wallet provider to do the transaction using the
mint()payload
Burn route
- Bank determines they have sufficient redemption capacity (e.g. from an outgoing wire for redemption) to burn USDA+
- Bank calls our API for the
burn()payload equal to the redemption amount less fees - Bank executes transaction from their wallet provider using the
burn()payload
Transfer route
- Bank wants to transfer USDA+ on-chain to another on-chain address
- Bank calls our API for the
transferFrom()payload - Bank executes transaction with their wallet provider using the
transferFrom()payload
Authentication
All API requests require Bearer token authentication. Include your API token in theAuthorization header:
Base URLs
| Environment | Base URL |
|---|---|
| Local | http://localhost:3000 |
Next steps
- Go to API Reference to see request/response schemas and try each endpoint.
- Use the Try it panel on any endpoint page to send live requests (with your API token).