Skip to main content

​
Locking fields

This page is for developers who want their users to land in the onramp’s widget with specific fields pre-filled and non-editable. Some service providers support locking the token and wallet address fields within their widgets. To do this, pass the lockFields parameter to the POST /crypto/session/widget endpoint with one or both of destinationCurrencyCode/sourceCurrencyCode (depending on buy vs sell flow) and walletAddress. The table below shows which service providers support locking which fields.
Service providerLocking cryptocurrencyLocking wallet address
Alchemy PayAlways locked when passed inAlways locked when passed in
BanxaAlways locked when passed inAlways locked when passed in
Binance ConnectAlways lockedAlways locked
BlockchainAlways locked when passed inAlways locked when passed in
BTC DirectAlways locked when passed inAlways locked when passed in
CoinbaseNot supportedNot supported
El DoradoAlways locked when passed inNot supported
FonbnkNot supportedSupported
GuardarianAlways locked when passed inSupported
KoyweAlways locked when passed inAlways locked when passed in
KryptonimAlways locked when passed inAlways locked when passed in
MercuryoSupportedNot supported
OnmetaAlways locked when passed inAlways locked when passed in
Onramp MoneyAlways locked when passed inAlways locked when passed in
PaybisNot supportedNot supported
RobinhoodAlways locked when passed inAlways locked when passed in
StripeSupportedSupported
SwappedNot supportedNot supported
TopperSupportedSupported
TransakSupportedSupported
TransFiAlways locked when passed inAlways locked when passed in
UnlimitSupportedSupported
YellowcardAlways locked when passed inAlways locked when passed in
Here’s a sample buy request with both the token and wallet address fields locked: 
{
    "sessionData": {
        "walletAddress": "2N3oefVeg6stiTb5Kh3ozCSkaqmx91FDbsm",
        "countryCode": "US",
        "sourceCurrencyCode": "USD",
        "sourceAmount": "100",
        "destinationCurrencyCode": "USDC",
        "serviceProvider": "TRANSAK",
        "lockFields": ["destinationCurrencyCode","walletAddress"]
    },
    "externalCustomerId": "test1",
    "externalSessionId": "test1"
}