USDF API
The USDF API allows you to mint and burn USDF coin. These endpoints require that you have been added to the USDF consortium smart contract and have authorized USDF usage through the Governance API.
Mint
POST /api/v1/mints
Initiate a new request to mint coin.
When a registered bank account is provided, corresponds with a directive from your bank account customer to convert fiat to USDF coin. Otherwise, minted coin will be held at your DCC middleware key pair address.
An Event API callback will be completed upon Provenance Blockchain execution.
Request
Sample Request
{
"uuid": "0bec12a9-0c39-403c-b713-b931dac8b25d",
"bankAccountUUID": "e886fda6-1ef2-4afb-85cd-05fc2a497929",
"amount": 500.25
}
Parameters
| Attribute | Type | Requirement | Notes |
|---|---|---|---|
uuid | string | Required | Idempotent request reference id |
bankAccountUUID | string | Optional | Registered bank account identifier |
amount | number | Required | The quantity of USDF coin to mint in USD |
Response
Returns a string value of uuid just requested.
Error Codes
400 - Bad Request
The body in the request is not valid.
500 - Internal Server Error
Some server error occurred.
Burn
POST /api/v1/burns
Initiate a new request to burn USDF coin held at your DCC middleware key pair address.
An Event API callback will be completed upon Provenance Blockchain execution.
Validation Note
You can only burn an amount that is less than or equal to the actual USDF coin balance at your DCC key pair address minus any pending burns and transfers.
Request
Sample Request
{
"uuid": "e85261ea-e519-481f-9972-2150a2120ba8",
"amount": 250.75
}
Parameters
| Attribute | Type | Requirement | Notes |
|---|---|---|---|
uuid | string | Required | Idempotent request reference id |
amount | number | Required | The quantity of USDF coin to burn in USD |
Response
Returns a string value of uuid just requested.
Error Codes
400 - Bad Request
The body in the request is not valid.
500 - Internal Server Error
Some server error occurred.
Transfer
POST /api/v1/transfers
Initiate a new request to transfer existing USDF coin at your DCC middleware key pair address to a registered address.
Validation Note
You can only transfer an amount that is less than or equal to the actual USDF coin balance at your DCC key pair address minus any pending burns and transfers.
Request
Sample Request
{
"uuid": "09dcbb63-c294-4a0e-8cda-afa561eb3941",
"bankAccountUuid": "e886fda6-1ef2-4afb-85cd-05fc2a497929",
"amount": 35.23
}
Parameters
| Attribute | Type | Requirement | Notes |
|---|---|---|---|
uuid | string | Required | Idempotent request reference id |
bankAccountUuid | string | Optional | Registered bank account identifier |
blockchainAddress | string | Optional | Provenance Blockchain account associated with a registered bank account |
amount | number | Required | The quantity of USDF coin to transfer in USD |
One of bankAccountUuid or blockchainAddress is required.
Response
Returns a string value of uuid just requested.
Error Codes
400 - Bad Request
The body in the request is not valid.
500 - Internal Server Error
Some server error occurred.