API reference
Links
Send USDF by link.
POST/v1/links
Creates a claimable USDF link.
Auth: API key: Authorization: Bearer sk_…
No parameters.
POST /v1/links
curl
curl -X POST https://api.usdf.fi/v1/links \ -H "Authorization: Bearer $USDF_API_KEY"
GET/v1/links/{token}
A link's amount and status.
Auth: None
| Name | Type | Required | Description |
|---|---|---|---|
token | string | Yes | Path. The link token. |
GET /v1/links/{token}
curl
curl https://api.usdf.fi/v1/links/{token}POST/v1/links/{token}/claim
Claims the link's USDF.
Auth: API key: Authorization: Bearer sk_…
| Name | Type | Required | Description |
|---|---|---|---|
token | string | Yes | Path. The link token. |
POST /v1/links/{token}/claim
curl
curl -X POST https://api.usdf.fi/v1/links/{token}/claim \
-H "Authorization: Bearer $USDF_API_KEY"POST/v1/links/{id}/cancel
Cancels an unclaimed link.
Auth: API key: Authorization: Bearer sk_…
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Path. The link id. |
POST /v1/links/{id}/cancel
curl
curl -X POST https://api.usdf.fi/v1/links/{id}/cancel \
-H "Authorization: Bearer $USDF_API_KEY"GET/v1/links/stats
Links created and claimed.
Auth: None
No parameters.
GET /v1/links/stats
curl
curl https://api.usdf.fi/v1/links/stats
Foundry documentation