Get On-ramp Status

curl --request GET \
  --url https://secureapi.tender.cash/v1/api/onramp/{reference} \
  --header 'authorization: <api-key>' \
  --header 'x-access-id: <x-access-id>' \
  --header 'x-request-id: <x-request-id>' \
  --header 'x-timestamp: <x-timestamp>'

const options = {
  method: 'GET',
  headers: {
    authorization: '<api-key>',
    'x-timestamp': '<x-timestamp>',
    'x-request-id': '<x-request-id>',
    'x-access-id': '<x-access-id>'
  }
};

fetch('https://secureapi.tender.cash/v1/api/onramp/{reference}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://secureapi.tender.cash/v1/api/onramp/{reference}"

headers = {
    "authorization": "<api-key>",
    "x-timestamp": "<x-timestamp>",
    "x-request-id": "<x-request-id>",
    "x-access-id": "<x-access-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://secureapi.tender.cash/v1/api/onramp/{reference}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <api-key>",
    "x-access-id: <x-access-id>",
    "x-request-id: <x-request-id>",
    "x-timestamp: <x-timestamp>"
  ],
]);

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

curl_close($curl);

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

{
  "status": "success",
  "message": "success",
  "data": {
    "reference": "a3f1c2d4-8e7b-4f0a-9c1d-2e3f4a5b6c7d",
    "status": "processing",
    "targetChain": "tron",
    "targetAddress": "TRDFGhjkytywooiueonuoo",
    "targetCurrency": "USDT",
    "fiatCurrency": "NGN",
    "fiatAmount": "50000",
    "amountReceived": "50000",
    "cryptoAmountOut": "29.87",
    "virtualAccount": {
      "accountNumber": "0123456789",
      "accountName": "Tender / Ada Obi",
      "bankName": "Wema Bank",
      "expiresAt": "2025-06-09T11:00:00.000Z"
    },
    "stages": {
      "payment": {
        "status": "completed",
        "attempts": 1
      },
      "payout": {
        "status": "completed",
        "attempts": 1
      },
      "swap": {
        "status": "in_progress",
        "attempts": 1
      },
      "swapWithdraw": {
        "status": "skipped",
        "attempts": 0
      },
      "cryptoSend": {
        "status": "pending",
        "attempts": 0
      }
    },
    "createdAt": "2025-06-09T10:00:00.000Z",
    "updatedAt": "2025-06-09T10:04:00.000Z"
  }
}

GET

api

onramp

{reference}

Get On-ramp Status

curl --request GET \
  --url https://secureapi.tender.cash/v1/api/onramp/{reference} \
  --header 'authorization: <api-key>' \
  --header 'x-access-id: <x-access-id>' \
  --header 'x-request-id: <x-request-id>' \
  --header 'x-timestamp: <x-timestamp>'

const options = {
  method: 'GET',
  headers: {
    authorization: '<api-key>',
    'x-timestamp': '<x-timestamp>',
    'x-request-id': '<x-request-id>',
    'x-access-id': '<x-access-id>'
  }
};

fetch('https://secureapi.tender.cash/v1/api/onramp/{reference}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://secureapi.tender.cash/v1/api/onramp/{reference}"

headers = {
    "authorization": "<api-key>",
    "x-timestamp": "<x-timestamp>",
    "x-request-id": "<x-request-id>",
    "x-access-id": "<x-access-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://secureapi.tender.cash/v1/api/onramp/{reference}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <api-key>",
    "x-access-id: <x-access-id>",
    "x-request-id: <x-request-id>",
    "x-timestamp: <x-timestamp>"
  ],
]);

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

curl_close($curl);

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

{
  "status": "success",
  "message": "success",
  "data": {
    "reference": "a3f1c2d4-8e7b-4f0a-9c1d-2e3f4a5b6c7d",
    "status": "processing",
    "targetChain": "tron",
    "targetAddress": "TRDFGhjkytywooiueonuoo",
    "targetCurrency": "USDT",
    "fiatCurrency": "NGN",
    "fiatAmount": "50000",
    "amountReceived": "50000",
    "cryptoAmountOut": "29.87",
    "virtualAccount": {
      "accountNumber": "0123456789",
      "accountName": "Tender / Ada Obi",
      "bankName": "Wema Bank",
      "expiresAt": "2025-06-09T11:00:00.000Z"
    },
    "stages": {
      "payment": {
        "status": "completed",
        "attempts": 1
      },
      "payout": {
        "status": "completed",
        "attempts": 1
      },
      "swap": {
        "status": "in_progress",
        "attempts": 1
      },
      "swapWithdraw": {
        "status": "skipped",
        "attempts": 0
      },
      "cryptoSend": {
        "status": "pending",
        "attempts": 0
      }
    },
    "createdAt": "2025-06-09T10:00:00.000Z",
    "updatedAt": "2025-06-09T10:04:00.000Z"
  }
}

Auth method: Signed (HMAC) — this endpoint requires the full set of signed headers: x-access-id, x-request-id, x-timestamp, and an HMAC-SHA256 authorization signature. See Authentication.

Overview

Returns the full on-ramp record for a given reference. Poll this endpoint after initiating an on-ramp to track which stage the pipeline is on.

Status values

Status	Meaning
`pending_payment`	Waiting for the customer’s fiat bank transfer
`processing`	Payment confirmed; pipeline is running
`crypto_sent`	Crypto dispatched to `targetAddress`
`completed`	Fully settled
`failed`	Terminal failure — see `failureReason` and `stages[*].lastError`

Stage pipeline

Each on-ramp progresses through the following stages in order:

Stage	Description
`payment`	Fiat payment confirmed by the provider
`payout`	Fiat forwarded to JuicyWay for conversion
`swap`	JuicyWay swaps fiat → intermediate crypto (e.g. USDT on Tron)
`swapWithdraw`	Swapped crypto withdrawn from JuicyWay to merchant swap wallet (skipped by default)
`cryptoSend`	Crypto sent from swap wallet to `targetAddress` (direct or via NEAR Intents bridge)

Each stage has its own status: pending · in_progress · completed · failed · skipped.

Headers

authorization

string

required

Base64-encoded HMAC-SHA256 signature using your API secretExample: "5e73d044c44d733fcf819ad3409aaa..."

x-timestamp

string

required

Example: "2025-03-15T09:45:53.000Z"

x-request-id

string

required

Example: "550e8400-e29b-41d4-a716-446655440000"

x-access-id

string

required

Example: "your-access-id-here"

Path Parameters

reference

string

required

The reference returned by Initiate On-rampExample: "a3f1c2d4-8e7b-4f0a-9c1d-2e3f4a5b6c7d"

Response

status

string

required

Example: "success"

message

string

required

Example: "success"

data

object

required

Show data properties

reference

string

Example: "a3f1c2d4-8e7b-4f0a-9c1d-2e3f4a5b6c7d"

quoteId

string

The quote ID that was used to initiate this requestExample: "b7f2a1c3-9d4e-4b2f-a8c0-1e2d3f4a5b6c"

status

string

Overall pipeline statusExample: "processing"

targetChain

string

Example: "tron"

targetAddress

string

Example: "TRDFGhjkytywooiueonuoo"

targetCurrency

string

Example: "USDT"

fiatCurrency

string

Example: "NGN"

fiatAmount

string

Example: "50000"

amountReceived

string

Fiat amount confirmed by the payment providerExample: "50000"

cryptoAmountOut

string

Amount of targetCurrency credited after the swapExample: "29.87"

virtualAccount

object

Bank account details presented to the customer

Show virtualAccount properties

accountNumber

string

Example: "0123456789"

accountName

string

Example: "Tender / Ada Obi"

bankName

string

Example: "Wema Bank"

expiresAt

string

Example: "2025-06-09T11:00:00.000Z"

stages

object

Per-stage progress. Each stage has the same shape.

Show stages properties

payment

object

Show stage shape

status

string

pending · in_progress · completed · failed · skipped

attempts

number

Example: 1

startedAt

string

Example: "2025-06-09T10:01:00.000Z"

completedAt

string

Example: "2025-06-09T10:02:30.000Z"

failedAt

string

Set only when status is failed

lastError

string

Error message from the last failed attempt

data

object

Stage-specific data (e.g. swapId, withdrawId, txRef)

payout

object

Same shape as payment

swap

object

Same shape as payment

swapWithdraw

object

Same shape as payment. Status is skipped by default.

cryptoSend

object

Same shape as payment

failureReason

string

Human-readable reason for terminal failure. Present only when status is failed.Example: "Swap wallet balance too low: 12 USDT < minimum 100"

createdAt

string

Example: "2025-06-09T10:00:00.000Z"

updatedAt

string

Example: "2025-06-09T10:05:00.000Z"

Authorizations

authorization

string

header

required

Signed (HMAC) authentication. Required headers: x-access-id, x-request-id (UUID v4), x-timestamp (ISO 8601), and authorization (Base64 HMAC-SHA256 signature of {timeStamp, requestId, accessId} using your access secret).

Headers

authorization

string

required

x-timestamp

string<date-time>

required

x-request-id

string<uuid>

required

x-access-id

string

required

Path Parameters

reference

string<uuid>

required

The reference returned by Initiate On-ramp

Response

On-ramp request retrieved successfully

status

string

message

string

data

object

Show child attributes

Initiate On-ramp

Payment

System

Conversions

Payouts

Subwallets

Webhooks

On-ramp

Get On-ramp Status

Overview

Status values

Stage pipeline

Headers

Path Parameters

Response

Authorizations

Headers

Path Parameters

Response

​Overview

​Status values

​Stage pipeline

​Headers

​Path Parameters

​Response

Authorizations

Headers

Path Parameters

Response

Overview

Status values

Stage pipeline

Headers

Path Parameters

Response