Postman Collection

The Rampnow Postman collection contains every partner API endpoint, with a pre-request script that signs each request for you. Use it to try the API before you write any code.

Rampnow partner API collection

Collection JSON, generated from the same OpenAPI spec as this API reference.

Prerequisites

A Rampnow Partner Dashboard account, with your API key and secret from the API Hub
The Postman app or Postman on the web

Set up the collection

Import the collection

In Postman, choose Import, paste this link and confirm:

https://rampnow-io.github.io/core/partner_external-postman.json

Add your credentials as collection variables

Open the imported collection, go to the Variables tab and add two variables. They must be collection variables: the signing script doesn’t read environment variables.

Variable	Value
`apiKey`	Your API key
`apiSecret`	Your API secret

Mark apiSecret as secret, and don’t share or export the collection with it filled in.

Choose the environment

The collection’s baseUrl variable defaults to production, https://api.rampnow.io. To use the sandbox, set it to https://api.sandbox.rampnow.io and use your sandbox key and secret. Keys only work on their own environment.

Send a request

Start with Onramp & Offramp Intent → Get a quote, edit the body and choose Send.

What’s in the collection

Requests are grouped into folders by API section:

Folder	Requests
Onramp & Offramp Intent	Get a quote, Create a checkout order, Get an order by external ID
Configuration	Get order config, Get asset config, Get chain config, Get token config, Get payment mode config, Get blocked currencies

Each request uses the full path, for example {{baseUrl}}/api/partner/v1/ext/ramp_order/quote, so baseUrl is the host only.

How request signing works

The collection runs this pre-request script before every request:

var apiKey = pm.collectionVariables.get("apiKey");;
var apiSecret = pm.collectionVariables.get("apiSecret");

var body = "";
if (pm.request.body.raw) {
    body = pm.request.body.raw;
} 

const timestamp = Date.now().toString();
let payload = [timestamp, pm.request.method, pm.request.url.getPathWithQuery(), body].join("")
let signature = CryptoJS.enc.Hex.stringify(CryptoJS.HmacSHA256(payload, apiSecret));

pm.request.headers.add({ key: "X-RAMPNOW-API-KEY", value: apiKey });
pm.request.headers.add({ key: "X-RAMPNOW-TIMESTAMP", value: timestamp });
pm.request.headers.add({ key: "X-RAMPNOW-SIGN", value: signature });

It follows the signing rules:

Reads apiKey and apiSecret from the collection variables.
Takes the raw request body, or an empty string if there is none.
Builds the message timestamp + method + path with query + body and signs it with HMAC-SHA256 using your secret.
Adds the X-RAMPNOW-API-KEY, X-RAMPNOW-TIMESTAMP and X-RAMPNOW-SIGN headers.

Because the body is signed exactly as Postman sends it, you can edit request bodies freely.

Two differences from the rules your own code should follow:

The script uses Date.now(), a timestamp in milliseconds, which the API currently accepts. Your own code must send seconds, as described in Authentication.
The script signs the body on any method. Leave the body of GET requests empty, or the signature won’t match.

Troubleshooting

401 with code 100002: check that apiKey and apiSecret are set as collection variables (not environment variables), and that the key matches the baseUrl environment. See Authentication → Troubleshooting.
200 with a non-zero code: the request reached the API but failed. Look the code up in Error Codes.

Next steps

Authentication: sign requests from your own code
API overview: endpoints and integration options
Error Codes: handle failures and retries

About API

Onramp & Offramp Intent

Configuration

Webhooks

Rampnow partner API collection

Prerequisites

Set up the collection

What’s in the collection

How request signing works

Troubleshooting

Next steps

Rampnow partner API collection

​Prerequisites

​Set up the collection

​What’s in the collection

​How request signing works

​Troubleshooting

​Next steps

Prerequisites

Set up the collection

What’s in the collection

How request signing works

Troubleshooting

Next steps