Event API

The Event API allows the DCC middleware to notify you of status updates.

Some events are for asynchronous processes you initialized such as USDF API requests. Others include USDF transfers to your DCC middleware key pair address representing requests to convert USDF back to fiat.

DCC Setup Note

DCC middleware is set up with a BANK_URI and BANK_CONTEXT environmental variables that represent the base endpoint of your bank application which is exposed for callback requests.

---

Complete Mint

POST /api/v1/mints/complete/{uuid}

Callback request to notify you that a mint is complete for the given uuid. Request was first initialized via USDF API mint request.

Request

This request does not require a POST body.

Response

Expects a 200 status code response with any string value.

Complete Burn

POST /api/v1/burns/complete/{uuid}

Callback request to notify you that a burn is complete for the given uuid. Request was first initialized via USDF API burn request.

Request

This request does not require a POST body.

Response

Expects a 200 status code response with any string value.

---

Deposit Fiat

POST /api/v1/fiat/deposits

Notification request that a registered Provenance Blockchain account has transferred USDF coin to DCC middleware key pair address. This represents a request to convert USDF back to fiat.

Deposit Note

DCC middleware does not couple a deposit fiat request to your bank with an automatic burn. You are responsible for initializing the burn process. See USDF API for burn instructions.

Request

Sample Request

{
    "uuid": "0bec12a9-0c39-403c-b713-b931dac8b25d",
    "bankAccountUUID": "e886fda6-1ef2-4afb-85cd-05fc2a497929",
    "amount": 150.75
}

Parameters

Attribute	Type	Requirement	Notes
uuid	string	Required	Idempotent request reference id
bankAccountUUID	string	Required	Registered bank account identifier
amount	number	Required	The quantity of USDF coin to redeem for fiat in USD

Response

Expects a 200 status code response with any string value.