User Limit

Get the current user limit and monthlyUsed limit for onramp and offramp.

User Limit Flow Diagram

This endpoint will return the current onramp, offramp and swap monthly limit used by user for onramp, offramp and swap and isNextKycVerificationRequired (whether the more kyc verification step(s) is/are required or not).

GET user limit details.

POST https://api.onramp.money/onramp/api/v2/whiteLabel/user/limit

Request Body

Name	Type	Description
customerId*	String	Unique id received from /kyc/url
fiatType*	Integer	Refer fiatType mapping. Fiat-Type Mapping

200: OK

{
    "status": 1,
    "code": 200,
    "data": {
        "onrampLimit": 7000,
        "offrampLimit": 7000,
        "swapLimit": 20000,
        "monthlyLimitUsedOnramp": 20,
        "monthlyLimitUsedOfframp": 0,
        "monthlyLimitUsedSwap": 1000,
        "isNextKycVerificationRequired": 1
    }
}

400: Bad Request Missing required parameter

If fiatType passed not matched with customerId fiatType.

500: Internal Server Error Internal Servor Error

Response

{
    "status": 1,
    "code": 200,
    "data": {
        "onrampLimit": 7000,
        "offrampLimit": 7000,
        "swapLimit": 20000,
        "monthlyLimitUsedOnramp": 20,
        "monthlyLimitUsedOfframp": 0,
        "monthlyLimitUsedSwap": 1000,
        "isNextKycVerificationRequired": 1
    }
}

Explanation

• status -> 0 is for unsuccessful request, 1 is for a successful one

• data -> current kycStatus can be

  • onrampLimit -> onramp limit of a user based on the kycStatus

  • offrampLimit -> offramp limit of a user based on the kycStatus

  • swapLimit -> swap limit of a user based on the kycStatus

  • monthlyLimitUsedOnramp -> monthly limit used by user for onramp

  • monthlyLimitUsedOfframp -> monthly limit used by user for offramp

  • monthlyLimitUsedSwap -> monthly limit used by user for swap

  • isNextKycVerificationRequired -> whether the more kyc verification steps of a user remaining or not. (1 -> remaining, 0-> full kyc verified)