Create a fiat order - Hypermid

Create a fiat order

curl --request POST \
  --url https://server.hypermid.io/onramp/checkout \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "srcAmount": "100",
  "srcCurrency": "USD",
  "dstCurrency": "USDC",
  "dstChain": "base",
  "walletAddress": "0x…",
  "paymentMode": "card",
  "orderType": "buy",
  "srcChain": "fiat",
  "email": "<string>",
  "returnUrl": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    srcAmount: '100',
    srcCurrency: 'USD',
    dstCurrency: 'USDC',
    dstChain: 'base',
    walletAddress: '0x…',
    paymentMode: 'card',
    orderType: 'buy',
    srcChain: 'fiat',
    email: '<string>',
    returnUrl: '<string>'
  })
};

fetch('https://server.hypermid.io/onramp/checkout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://server.hypermid.io/onramp/checkout"

payload = {
    "srcAmount": "100",
    "srcCurrency": "USD",
    "dstCurrency": "USDC",
    "dstChain": "base",
    "walletAddress": "0x…",
    "paymentMode": "card",
    "orderType": "buy",
    "srcChain": "fiat",
    "email": "<string>",
    "returnUrl": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

POST

/

onramp

/

checkout

Create a fiat order

curl --request POST \
  --url https://server.hypermid.io/onramp/checkout \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "srcAmount": "100",
  "srcCurrency": "USD",
  "dstCurrency": "USDC",
  "dstChain": "base",
  "walletAddress": "0x…",
  "paymentMode": "card",
  "orderType": "buy",
  "srcChain": "fiat",
  "email": "<string>",
  "returnUrl": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    srcAmount: '100',
    srcCurrency: 'USD',
    dstCurrency: 'USDC',
    dstChain: 'base',
    walletAddress: '0x…',
    paymentMode: 'card',
    orderType: 'buy',
    srcChain: 'fiat',
    email: '<string>',
    returnUrl: '<string>'
  })
};

fetch('https://server.hypermid.io/onramp/checkout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://server.hypermid.io/onramp/checkout"

payload = {
    "srcAmount": "100",
    "srcCurrency": "USD",
    "dstCurrency": "USDC",
    "dstChain": "base",
    "walletAddress": "0x…",
    "paymentMode": "card",
    "orderType": "buy",
    "srcChain": "fiat",
    "email": "<string>",
    "returnUrl": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

Authorizations

x-api-key

string

header

required

Soft-auth read routes accept x-api-key with a publishable or partner key; money-moving routes require a secret partner key in Authorization: Bearer.

Body

application/json

srcAmount

string

required

Fiat amount to spend (decimal string).

Example:

"100"

srcCurrency

string

required

Fiat currency code (ISO 4217).

Example:

"USD"

dstCurrency

string

required

Destination crypto asset symbol.

Example:

"USDC"

dstChain

string

required

Destination chain code, as used by the fiat provider. Read the supported set from the onramp config endpoint rather than assuming it matches a chain id.

Example:

"base"

walletAddress

string

required

Payer wallet address (required for checkout).

Example:

"0x…"

paymentMode

string

Payment method code.

Example:

"card"

orderType

string

Order direction. Defaults to buy.

Example:

"buy"

srcChain

string

The rail the payer FUNDS with. Defaults to fiat.

Example:

"fiat"

email

string

Payer email. Forwarded to the payment provider for identity checks, and stored by Hypermid with the order for support and to recognise repeat orders.

returnUrl

string

Post-payment return URL. Only honoured when its origin is in ONRAMP_RETURN_ORIGINS; otherwise the default is used (open-redirect guard).

Response

201