Skip to main content
Hosted mode gives you full control over the user experience. Users stay on your platform throughout the entire flow.

​
Overview

The Hosted method is the simplest and fastest way to integrate Rampnow’s services. Unlike widget integration, users never leave your platform untill Payment and KYC features —you control the entire experience.

Seamless Experience

Keep users on your platform throughout the entire flow

Custom Branding

Minimal Rampnow branding, maximum control

​
Implementation Steps

1

Onboard User

First, onboard your user to Rampnow through the KYC Share API. If KYC share is not used, Rampnow will iniatite a KYC process during the transaction process.
Before calling this API, Sumsub KYC share setup must be completed with Rampnow if you want to use KYC share feature. Contact [email protected] for setup details.
  • To create the customer/ onboard the retail users , Please follow https://api.rampnow.io/api/partner/v1/ext/customer_user end point.
  • Request body
curl --request POST \
--url https://api.rampnow.io/api/partner/v1/ext/customer_user \
--header 'Content-Type: application/json' \
--data '
{
"kycShareReq": {
"token": "<string>"
},
"userDetail": {
"address": {
  "city": "<string>",
  "country": "AD",
  "line1": "<string>",
  "line2": "<string>",
  "postalCode": "<string>",
  "state": "<string>",
  "subDivision": "<string>"
},
"amlData": {
  "estimatedAnnualTradeVolume": "<string>",
  "fundSource": "<string>",
  "isPoliticallyExposed": "<string>"
},
"country": "AD",
"createdAt": "2023-11-07T05:31:56Z",
"dateOfBirth": "<string>",
"email": "<string>",
"firstName": "<string>",
"gender": "unknown",
"ipAddress": "<string>",
"lastName": "<string>",
"phone": "<string>",
"remarks": "<string>",
"riskStatus": "unknown",
"status": "unknown",
"uid": "<string>"
}
}

​
Field Description

list of most important fields and descriptions.
PropertyNeedDescription
kycShareReq.tokenOptionalDescription
userDetail.countryDescription
Reported ageDescription
JoinedWhether the user joined the communityDescription
2

Create Order

Once onboarded, create an order using the Create Hosted Order API. The response contains all payment details to display on your UI.
// API response example
{
  "orderId": "...",
  "paymentDetails": {...}
}
3

Set Up Webhooks (Optional)

Track transaction status in real-time by configuring webhooks in your Rampnow Partner Dashboard.
Webhook setup documentation is available in our API Documentation.

​
When to Use Hosted Mode

  • Platforms requiring seamless customer experience
  • Teams wanting minimal Rampnow branding
  • Applications needing full UI control
  • Requires custom UI development on your end
  • Integration takes longer than widget mode
  • Not all payment methods are supported

​
Next Steps

Ready to integrate? Start with the KYC Share API, then create your first order, and set up webhooks for status tracking.