Skip to main content
POST
/
partner-fees
Create a partner fee
curl --request POST \
  --url https://api.lumx.io/partner-fees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Fee 7",
  "walletAddress": "0x76b74209f3542d172ca1575b5b18064594360299",
  "fees": {
    "onRamp": {
      "rate": "10",
      "flatAmount": "1"
    },
    "offRamp": {
      "rate": "10",
      "flatAmount": "1"
    }
  }
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174004",
  "name": "Fee name",
  "walletAddress": "0x76b74209f3542d172ca1575b5b18064594360299",
  "fees": {
    "onRamp": {
      "rate": "10",
      "flatAmount": "1"
    },
    "offRamp": {
      "rate": "10",
      "flatAmount": "1"
    }
  },
  "createdAt": "2021-01-01T00:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Headers

​
Idempotency-Key
string<uuid>

Optional UUID v4 idempotency key. If you resend the same key with a different request body, the API returns a 409 error. Cached responses include the header X-Idempotency-Cached: true. Keys expire after 24 hours.

Body

application/json
​
name
string
required

Partner fee's name.

Example:

"Fee 7"

​
walletAddress
string
required

Partner's wallet address that will receive the funds.

Example:

"0x76b74209f3542d172ca1575b5b18064594360299"

​
fees
object
required

Partner fee's fees.

Response

201 - application/json

Partner fee successfully created.

​
id
string<uuid>

Partner fee's unique identifier.

Example:

"123e4567-e89b-12d3-a456-426614174004"

​
name
string

Partner fee's name.

Example:

"Fee name"

​
walletAddress
string

Partner's wallet address that will receive the funds.

Example:

"0x76b74209f3542d172ca1575b5b18064594360299"

​
fees
object

Partner fee's fees.

​
createdAt
string<date-time>

Creation date and time (UTC).

Example:

"2021-01-01T00:00:00Z"