Create an intent order

curl --request POST \
  --url https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout \
  --header 'Content-Type: application/json' \
  --header 'X-RAMPNOW-API-KEY: <api-key>' \
  --data '
{
  "externalOrderUid": "<string>",
  "srcChain": "<string>",
  "srcCurrency": "<string>",
  "user": {
    "country": "<string>",
    "dateOfBirth": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>"
  },
  "addressTag": "<string>",
  "dstAmount": "<string>",
  "dstChain": "<string>",
  "dstCurrency": "<string>",
  "partnerFixedFee": 123,
  "partnerPctFee": 123,
  "paymentMode": "<string>",
  "returnUrl": "<string>",
  "srcAmount": "<string>",
  "webhookUrl": "<string>"
}
'

import requests

url = "https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout"

payload = {
    "externalOrderUid": "<string>",
    "srcChain": "<string>",
    "srcCurrency": "<string>",
    "user": {
        "country": "<string>",
        "dateOfBirth": "<string>",
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phone": "<string>"
    },
    "addressTag": "<string>",
    "dstAmount": "<string>",
    "dstChain": "<string>",
    "dstCurrency": "<string>",
    "partnerFixedFee": 123,
    "partnerPctFee": 123,
    "paymentMode": "<string>",
    "returnUrl": "<string>",
    "srcAmount": "<string>",
    "webhookUrl": "<string>"
}
headers = {
    "X-RAMPNOW-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-RAMPNOW-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    externalOrderUid: '<string>',
    srcChain: '<string>',
    srcCurrency: '<string>',
    user: {
      country: '<string>',
      dateOfBirth: '<string>',
      email: '<string>',
      firstName: '<string>',
      lastName: '<string>',
      phone: '<string>'
    },
    addressTag: '<string>',
    dstAmount: '<string>',
    dstChain: '<string>',
    dstCurrency: '<string>',
    partnerFixedFee: 123,
    partnerPctFee: 123,
    paymentMode: '<string>',
    returnUrl: '<string>',
    srcAmount: '<string>',
    webhookUrl: '<string>'
  })
};

fetch('https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'externalOrderUid' => '<string>',
    'srcChain' => '<string>',
    'srcCurrency' => '<string>',
    'user' => [
        'country' => '<string>',
        'dateOfBirth' => '<string>',
        'email' => '<string>',
        'firstName' => '<string>',
        'lastName' => '<string>',
        'phone' => '<string>'
    ],
    'addressTag' => '<string>',
    'dstAmount' => '<string>',
    'dstChain' => '<string>',
    'dstCurrency' => '<string>',
    'partnerFixedFee' => 123,
    'partnerPctFee' => 123,
    'paymentMode' => '<string>',
    'returnUrl' => '<string>',
    'srcAmount' => '<string>',
    'webhookUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-RAMPNOW-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout"

	payload := strings.NewReader("{\n  \"externalOrderUid\": \"<string>\",\n  \"srcChain\": \"<string>\",\n  \"srcCurrency\": \"<string>\",\n  \"user\": {\n    \"country\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"addressTag\": \"<string>\",\n  \"dstAmount\": \"<string>\",\n  \"dstChain\": \"<string>\",\n  \"dstCurrency\": \"<string>\",\n  \"partnerFixedFee\": 123,\n  \"partnerPctFee\": 123,\n  \"paymentMode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"srcAmount\": \"<string>\",\n  \"webhookUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-RAMPNOW-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout")
  .header("X-RAMPNOW-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalOrderUid\": \"<string>\",\n  \"srcChain\": \"<string>\",\n  \"srcCurrency\": \"<string>\",\n  \"user\": {\n    \"country\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"addressTag\": \"<string>\",\n  \"dstAmount\": \"<string>\",\n  \"dstChain\": \"<string>\",\n  \"dstCurrency\": \"<string>\",\n  \"partnerFixedFee\": 123,\n  \"partnerPctFee\": 123,\n  \"paymentMode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"srcAmount\": \"<string>\",\n  \"webhookUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-RAMPNOW-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalOrderUid\": \"<string>\",\n  \"srcChain\": \"<string>\",\n  \"srcCurrency\": \"<string>\",\n  \"user\": {\n    \"country\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"addressTag\": \"<string>\",\n  \"dstAmount\": \"<string>\",\n  \"dstChain\": \"<string>\",\n  \"dstCurrency\": \"<string>\",\n  \"partnerFixedFee\": 123,\n  \"partnerPctFee\": 123,\n  \"paymentMode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"srcAmount\": \"<string>\",\n  \"webhookUrl\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "data": {
    "orderUid": "<string>",
    "redirectUrl": "<string>",
    "userUid": "<string>"
  },
  "message": "<string>",
  "traceId": "<string>",
  "displayError": "<string>"
}

POST

api

partner

ext

ramp_order

checkout

Create an intent order

curl --request POST \
  --url https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout \
  --header 'Content-Type: application/json' \
  --header 'X-RAMPNOW-API-KEY: <api-key>' \
  --data '
{
  "externalOrderUid": "<string>",
  "srcChain": "<string>",
  "srcCurrency": "<string>",
  "user": {
    "country": "<string>",
    "dateOfBirth": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>"
  },
  "addressTag": "<string>",
  "dstAmount": "<string>",
  "dstChain": "<string>",
  "dstCurrency": "<string>",
  "partnerFixedFee": 123,
  "partnerPctFee": 123,
  "paymentMode": "<string>",
  "returnUrl": "<string>",
  "srcAmount": "<string>",
  "webhookUrl": "<string>"
}
'

import requests

url = "https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout"

payload = {
    "externalOrderUid": "<string>",
    "srcChain": "<string>",
    "srcCurrency": "<string>",
    "user": {
        "country": "<string>",
        "dateOfBirth": "<string>",
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phone": "<string>"
    },
    "addressTag": "<string>",
    "dstAmount": "<string>",
    "dstChain": "<string>",
    "dstCurrency": "<string>",
    "partnerFixedFee": 123,
    "partnerPctFee": 123,
    "paymentMode": "<string>",
    "returnUrl": "<string>",
    "srcAmount": "<string>",
    "webhookUrl": "<string>"
}
headers = {
    "X-RAMPNOW-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-RAMPNOW-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    externalOrderUid: '<string>',
    srcChain: '<string>',
    srcCurrency: '<string>',
    user: {
      country: '<string>',
      dateOfBirth: '<string>',
      email: '<string>',
      firstName: '<string>',
      lastName: '<string>',
      phone: '<string>'
    },
    addressTag: '<string>',
    dstAmount: '<string>',
    dstChain: '<string>',
    dstCurrency: '<string>',
    partnerFixedFee: 123,
    partnerPctFee: 123,
    paymentMode: '<string>',
    returnUrl: '<string>',
    srcAmount: '<string>',
    webhookUrl: '<string>'
  })
};

fetch('https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'externalOrderUid' => '<string>',
    'srcChain' => '<string>',
    'srcCurrency' => '<string>',
    'user' => [
        'country' => '<string>',
        'dateOfBirth' => '<string>',
        'email' => '<string>',
        'firstName' => '<string>',
        'lastName' => '<string>',
        'phone' => '<string>'
    ],
    'addressTag' => '<string>',
    'dstAmount' => '<string>',
    'dstChain' => '<string>',
    'dstCurrency' => '<string>',
    'partnerFixedFee' => 123,
    'partnerPctFee' => 123,
    'paymentMode' => '<string>',
    'returnUrl' => '<string>',
    'srcAmount' => '<string>',
    'webhookUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-RAMPNOW-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout"

	payload := strings.NewReader("{\n  \"externalOrderUid\": \"<string>\",\n  \"srcChain\": \"<string>\",\n  \"srcCurrency\": \"<string>\",\n  \"user\": {\n    \"country\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"addressTag\": \"<string>\",\n  \"dstAmount\": \"<string>\",\n  \"dstChain\": \"<string>\",\n  \"dstCurrency\": \"<string>\",\n  \"partnerFixedFee\": 123,\n  \"partnerPctFee\": 123,\n  \"paymentMode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"srcAmount\": \"<string>\",\n  \"webhookUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-RAMPNOW-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout")
  .header("X-RAMPNOW-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalOrderUid\": \"<string>\",\n  \"srcChain\": \"<string>\",\n  \"srcCurrency\": \"<string>\",\n  \"user\": {\n    \"country\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"addressTag\": \"<string>\",\n  \"dstAmount\": \"<string>\",\n  \"dstChain\": \"<string>\",\n  \"dstCurrency\": \"<string>\",\n  \"partnerFixedFee\": 123,\n  \"partnerPctFee\": 123,\n  \"paymentMode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"srcAmount\": \"<string>\",\n  \"webhookUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rampnow.io/api/partner/v1/ext/ramp_order/checkout")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-RAMPNOW-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalOrderUid\": \"<string>\",\n  \"srcChain\": \"<string>\",\n  \"srcCurrency\": \"<string>\",\n  \"user\": {\n    \"country\": \"<string>\",\n    \"dateOfBirth\": \"<string>\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"addressTag\": \"<string>\",\n  \"dstAmount\": \"<string>\",\n  \"dstChain\": \"<string>\",\n  \"dstCurrency\": \"<string>\",\n  \"partnerFixedFee\": 123,\n  \"partnerPctFee\": 123,\n  \"paymentMode\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"srcAmount\": \"<string>\",\n  \"webhookUrl\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "data": {
    "orderUid": "<string>",
    "redirectUrl": "<string>",
    "userUid": "<string>"
  },
  "message": "<string>",
  "traceId": "<string>",
  "displayError": "<string>"
}

Authorizations

X-RAMPNOW-API-KEY

string

header

required

Partner API key sent in the X-RAMPNOW-API-KEY header. Every request must ALSO send X-RAMPNOW-TIMESTAMP (unix seconds) and X-RAMPNOW-SIGN (hex HMAC-SHA256 of timestamp + METHOD + requestURI + rawBody, keyed with your API secret). See the Authentication guide.

Body

application/json

externalOrderUid

string

required

Your unique reference for this order (idempotency key)

orderType

enum<string>

required

Order direction (buy, sell, …)

Available options:

unknown,

buy,

sell,

swap,

payment,

refill,

payout,

cross_border,

payroll,

sendout,

escrow

srcChain

string

required

Source chain (fiat for fiat legs)

Supported Blockchains like ethereum, bitcoin etc. For additional options, see the full list.

srcCurrency

string

required

Source currency (fiat for buy, crypto for sell)

Supported Crypto Currencies like EUR, USDT etc. For additional options, see the full list.

user

object

required

Customer profile; upserted by email

Show child attributes

addressTag

string

Destination address memo/tag for chains that require one (XRP, XLM, TON, …)

dstAmount

string

Destination-side amount; set this OR srcAmount, not both

dstChain

string

Destination chain (fiat for fiat legs)

Supported Blockchains like ethereum, bitcoin etc. For additional options, see the full list.

dstCurrency

string

Destination currency (crypto for buy, fiat for sell)

Supported Crypto Currencies like EUR, USDT etc. For additional options, see the full list.

partnerFixedFee

number

Overrides the account-side partner fixed fee for this order

partnerPctFee

number

Overrides the account-side partner fee percentage for this order

paymentMode

string

Preferred payment method; if omitted the customer picks during checkout

Payment Methods & Limits like sepa, card, wire etc. For additional options, see the full list.

returnUrl

string

URL to redirect the customer to after checkout completes

srcAmount

string

Source-side amount; set this OR dstAmount, not both

wallet

object

Beneficiary wallet / bank account for the destination leg

Show child attributes

webhookUrl

string

Per-order override for the status-change webhook URL; falls back to the account-level webhook

Response

200 - application/json

code

integer

required

data

object

required

Show child attributes

message

string

required

traceId

string

required

displayError

string

For client display

About API

Onramp & Offramp Intent

Configuration

Webhooks

Create an intent order

Authorizations

Body

Response