API Reference

PreviousFAQ NextGeneral

Last updated 1 year ago

get

Authorizations

Query parameters

unitsstringOptional

includeParametersstringOptional

Responses

200

Accounts

application/json

500Error

application/json

get

GET /earn/accounts HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "next": "text",
  "count": 1,
  "data": [
    {
      "currency": "EUR",
      "activeAmount": "text",
      "blockedAmount": "text",
      "accruedInterest": "text",
      "pendingWithdrawAmount": "text",
      "status": {
        "status": "ACTIVE",
        "reason": "text"
      },
      "allowedDestinations": [
        "CARD"
      ],
      "target": "EARN",
      "userId": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

get

Authorizations

Path parameters

accountIdstring · uuidRequired

Query parameters

unitsstringOptional

Responses

200

Account Withdrawals

application/json

404Error

application/json

500Error

application/json

get

GET /earn/accounts/{accountId}/withdrawals HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "next": "text",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "currency": "EUR",
      "withdrawalFee": "text",
      "withdrawalDate": "2025-06-09T07:18:58.009Z",
      "amount": "text",
      "status": "PENDING"
    }
  ],
  "count": 1
}

get

Authorizations

Path parameters

accountIdstring · uuidRequired

Query parameters

unitsstringOptional

Responses

200

Account

application/json

404Error

application/json

500Error

application/json

get

GET /earn/accounts/{accountId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "currency": "EUR",
  "activeAmount": "text",
  "blockedAmount": "text",
  "accruedInterest": "text",
  "pendingWithdrawAmount": "text",
  "status": {
    "status": "ACTIVE",
    "reason": "text"
  },
  "allowedDestinations": [
    "CARD"
  ],
  "target": "EARN",
  "userId": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

get

Authorizations

Path parameters

accountIdstring · uuidRequired

Query parameters

unitsstringOptional

Responses

200

Account transactions

application/json

500Error

application/json

get

GET /earn/accounts/{accountId}/transactions HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "next": "text",
  "count": 1,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "currency": "EUR",
      "fee": "text",
      "timestamp": "2025-06-09T07:18:58.009Z",
      "amount": "text",
      "type": "EARN"
    }
  ]
}

get

Authorizations

Responses

200

Parameters

application/json

500Error

application/json

get

GET /earn/accounts/parameters HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "BTC": {
    "interestRate": "text",
    "interestRateGross": "text",
    "weeklyPercentage": "text",
    "weeklyPercentageGross": "text",
    "withdrawalRates": {
      "maxDaysForVariableFee": 1,
      "minLiquidityPeriod": 1,
      "variableFee": 1,
      "fixedFee": 1,
      "minFees": [
        1
      ]
    },
    "withdrawalDailyLimit": "text"
  },
  "ETH": {
    "interestRate": "text",
    "interestRateGross": "text",
    "weeklyPercentage": "text",
    "weeklyPercentageGross": "text",
    "withdrawalRates": {
      "maxDaysForVariableFee": 1,
      "minLiquidityPeriod": 1,
      "variableFee": 1,
      "fixedFee": 1,
      "minFees": [
        1
      ]
    },
    "withdrawalDailyLimit": "text"
  },
  "EUR": {
    "interestRate": "text",
    "interestRateGross": "text",
    "weeklyPercentage": "text",
    "weeklyPercentageGross": "text",
    "withdrawalRates": {
      "maxDaysForVariableFee": 1,
      "minLiquidityPeriod": 1,
      "variableFee": 1,
      "fixedFee": 1,
      "minFees": [
        1
      ]
    },
    "withdrawalDailyLimit": "text"
  },
  "USDC": {
    "interestRate": "text",
    "interestRateGross": "text",
    "weeklyPercentage": "text",
    "weeklyPercentageGross": "text",
    "withdrawalRates": {
      "maxDaysForVariableFee": 1,
      "minLiquidityPeriod": 1,
      "variableFee": 1,
      "fixedFee": 1,
      "minFees": [
        1
      ]
    },
    "withdrawalDailyLimit": "text"
  }
}

get

Authorizations

Path parameters

currencystring · enumRequiredPossible values:

Responses

200

Parameters

application/json

500Error

application/json

get

GET /earn/accounts/parameters/{currency} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "interestRate": "text",
  "interestRateGross": "text",
  "weeklyPercentage": "text",
  "weeklyPercentageGross": "text",
  "withdrawalRates": {
    "maxDaysForVariableFee": 1,
    "minLiquidityPeriod": 1,
    "variableFee": 1,
    "fixedFee": 1,
    "minFees": [
      1
    ]
  },
  "withdrawalDailyLimit": "text"
}

get

Authorizations

Responses

200Success

application/json

500Error

application/json

get

GET /earn/preferences HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "earnTutorialRead": true,
  "earn90TutorialRead": true,
  "earn180TutorialRead": true,
  "earn360TutorialRead": true
}

get

Authorizations

Path parameters

investmentIdstring · uuidRequired

Query parameters

unitsstringOptional

Responses

200

Investment

application/json

500Error

application/json

get

GET /earn/investments/{investmentId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "currency": "EUR",
  "dateEnd": "2025-06-09T07:18:58.009Z",
  "dateFirstReward": "2025-06-09T07:18:58.009Z",
  "status": "COMPLETED",
  "timesRewarded": "text",
  "userId": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "product": "EARN_90",
  "autorenewal": false,
  "amount": "text",
  "dateStart": "2025-06-09T07:18:58.009Z",
  "expectedAmount": "text",
  "numberOfRewards": "text",
  "apy": "text",
  "apyGross": "text",
  "roi": "text",
  "roiGross": "text",
  "weeklyReward": "text"
}

get

Authorizations

Query parameters

currencystring · enumOptionalPossible values:

unitsstringOptional

nextstringOptional

limitstringOptional

Responses

200

Investments

application/json

500Error

application/json

get

GET /earn/investments HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "next": "text",
  "count": 1,
  "data": [
    {
      "currency": "EUR",
      "dateEnd": "2025-06-09T07:18:58.009Z",
      "dateFirstReward": "2025-06-09T07:18:58.009Z",
      "status": "COMPLETED",
      "timesRewarded": "text",
      "userId": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "product": "EARN_90",
      "autorenewal": false,
      "amount": "text",
      "dateStart": "2025-06-09T07:18:58.009Z",
      "expectedAmount": "text",
      "numberOfRewards": "text",
      "apy": "text",
      "apyGross": "text",
      "roi": "text",
      "roiGross": "text",
      "weeklyReward": "text"
    }
  ]
}

get

Authorizations

Query parameters

currencystring · enumOptionalPossible values:

Responses

200

Offers

application/json

500Error

application/json

get

GET /earn/investments/offers HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "data": [
    {
      "product": "EARN_90",
      "currency": "EUR",
      "minDepositAmount": "text",
      "apy": "text",
      "roi": "text",
      "roiGross": "text",
      "apyGross": "text",
      "numberOfRewards": "text",
      "id": "text",
      "dateStart": "2025-06-09T07:18:58.009Z",
      "dateEnd": "2025-06-09T07:18:58.009Z"
    }
  ],
  "count": 1
}

delete

Authorizations

Path parameters

accountIdstring · uuidRequired

withdrawalIdstringRequired

Responses

200

Withdrawal canceled

application/json

400Error

application/json

404

Account not found

application/json

500Error

application/json

delete

DELETE /earn/accounts/{accountId}/withdrawals/{withdrawalId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "success": true
}

post

Authorizations

Path parameters

accountIdstring · uuidRequired

Body

amountstringRequired

rewardIdstringOptional

Responses

200

Funds added to account

application/json

400Error

application/json

404

Account not found

application/json

500Error

application/json

post

POST /earn/accounts/{accountId}/funds HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "amount": "text",
  "rewardId": "text"
}

{
  "success": true
}

post

Authorizations

Query parameters

unitsstringOptional

Body

currencystring · enumRequiredPossible values:

Responses

201

Account created

application/json

400Error

application/json

500Error

application/json

post

POST /earn/accounts HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "currency": "EUR"
}

{
  "currency": "EUR",
  "activeAmount": "text",
  "blockedAmount": "text",
  "accruedInterest": "text",
  "pendingWithdrawAmount": "text",
  "status": {
    "status": "ACTIVE",
    "reason": "text"
  },
  "allowedDestinations": [
    "CARD"
  ],
  "target": "EARN",
  "userId": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

post

Authorizations

Path parameters

accountIdstring · uuidRequired

Body

amountstringRequired

withdrawalDatestringRequired

Responses

201

Withdrawal created

application/json

400Error

application/json

500Error

application/json

post

POST /earn/accounts/{accountId}/withdrawals HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "amount": "text",
  "withdrawalDate": "text"
}

{
  "success": true
}

put

Authorizations

Body

earnTutorialReadbooleanOptional

earn90TutorialReadbooleanOptional

earn180TutorialReadbooleanOptional

earn360TutorialReadbooleanOptional

Responses

200Success

application/json

500Error

application/json

put

PUT /earn/preferences HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "earnTutorialRead": true,
  "earn90TutorialRead": true,
  "earn180TutorialRead": true,
  "earn360TutorialRead": true
}

{
  "earnTutorialRead": true,
  "earn90TutorialRead": true,
  "earn180TutorialRead": true,
  "earn360TutorialRead": true
}

patch

Authorizations

Path parameters

investmentIdstring · uuidRequired

Body

autorenewbooleanRequired

Responses

200

Investment updated

application/json

400Error

application/json

404Error

application/json

500Error

application/json

patch

PATCH /earn/investments/{investmentId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "autorenew": true
}

{
  "currency": "EUR",
  "dateEnd": "2025-06-09T07:18:58.009Z",
  "dateFirstReward": "2025-06-09T07:18:58.009Z",
  "status": "COMPLETED",
  "timesRewarded": "text",
  "userId": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "product": "EARN_90",
  "autorenewal": false,
  "amount": "text",
  "dateStart": "2025-06-09T07:18:58.009Z",
  "expectedAmount": "text",
  "numberOfRewards": "text",
  "apy": "text",
  "apyGross": "text",
  "roi": "text",
  "roiGross": "text",
  "weeklyReward": "text"
}

post

Authorizations

Body

amountstringRequired

autorenewalbooleanRequiredDefault: false

currencystring · enumRequiredPossible values:

offerIdstringRequired

rewardIdstringOptional

Responses

201

Investment created

application/json

400Error

application/json

500Error

application/json

post

POST /earn/investments HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "amount": "text",
  "autorenewal": false,
  "currency": "EUR",
  "offerId": "text",
  "rewardId": "text"
}

{
  "currency": "EUR",
  "dateEnd": "2025-06-09T07:18:58.009Z",
  "dateFirstReward": "2025-06-09T07:18:58.009Z",
  "status": "COMPLETED",
  "timesRewarded": "text",
  "userId": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "product": "EARN_90",
  "autorenewal": false,
  "amount": "text",
  "dateStart": "2025-06-09T07:18:58.009Z",
  "expectedAmount": "text",
  "numberOfRewards": "text",
  "apy": "text",
  "apyGross": "text",
  "roi": "text",
  "roiGross": "text",
  "weeklyReward": "text"
}