Payments Order

Query the status and details of a specific payments order by its product transaction rampId.

This feature is intended only for merchants who require customized order details rendering. In most cases, integration simply requires enabling Webhooks callback to receive order event notifications and handling the callback accordingly.

---

API

GET /payment/order

Example:

GET {API_DOMAIN}/payment/order?rampId=0xabc123dd

Query Params

Name	Type	Required	Description
rampId	string*	✅ Required	Unique merchant transaction id merchant_transaction_id

Authentication Headers

API requests are rate-limited. Please avoid excessive calls.

Name	Type	Required	Description
x-appid	string*	✅ Required	Your merchant appid
x-signature	string*	✅ Required	HMAC-SHA256 signature generated from your API Secret

Generating the Signature

The x-signature is generated by signing your appid with your API Secret using HMAC-SHA256.

import { createHmac } from 'crypto'

export function createHmacSignature(secret: string, data: string): string {
  return createHmac('sha256', secret).update(data).digest('hex')
}

1. This endpoint supports both crypto and fiat payments, and the rampId value must be globally unique.

2. The rampId represents the unique merchant_transaction_id used for transactions between the developer and the consumer, and is stored in the database as rampId.

---

Success Response

✅ 200 - Success Example

Fiat

{
  "ok": true,
  "data": {
    "id": "690e31d***ba6ef8215",
    "payeeId": "1_N1yAE6D***v1oTd6Uoz",
    "appid": "business_app_abc123",
    "name": "David Lin",
    "email": "[email protected]",
    "payer": "0x68b37Db3E727***d0B76195eB929Db649",
    "payMethod": "card",
    "rampId": "24615901***47304960",
    "rampType": "pay",
    "rampStatus": "completed",
    "chain": "BASE",
    "symbol": "USDC",
    "fiatCoin": "AED",
    "fiatAmount": 70,
    "amount": 17.852559,
    "reserveAmount": 0.892628,
    "afterReserveAmount": 16.95987,
    "usd": 17.85,
    "signature": "0xa280***e8fec1",
    "settledAt": "2025-11-07T17:55:08.220Z",
    "createdAt": "2025-11-07T17:52:17.293Z",
    "updatedAt": "2025-11-07T17:55:10.100Z"
  }
}

Crypto

---

Error Response

404 - Not found

{
  "ok": false,
  "message": "Payment not found ˙◠˙"
}

401 - Invalid signature

{
  "ok": false,
  "message": "Invalid signature ˙◠˙"
}

---

cURL Request

curl "https://api.coindpay.xyz/payment/order?rampId=0xabc123dd" \
  -H "x-appid: YOUR_APP_ID" \
  -H "x-signature: YOUR_SIGNATURE"

Full Order Fields

Field	Type	Description
id	string*	Unique payment Id
payeeId	string*	Product or service Id
uuid	string*	Internal Id of the payee (receiver) for webhooks data-key appid
name	string?	Name of the payer (optional)
email	string*	Email of the payer (optional)
message	string?	Optional payment message
payer	string*	Wallet address (for crypto payments)
payMethod	string?	Fiat payment method type (e.g., apple/google/card...)
rampId	string?	Order ID that is paid for through Ramps service provider（The merchant_transaction_id provided by the merchants）
rampType	string?	Payment type (pay/buy/sell) through multi-provider
rampStatus	string*	Order status of payment completed through Ramps service provider
fiatCoin	string?	Fiat currency code (e.g., USD)
fiatAmount	float?	Fiat amount paid (if any)
chain	string*	Blockchain name (e.g., solana, ethereum)
symbol	string*	Token symbol (e.g., USDT, USDC)
contract	string?	Contract address of the token
amount	float*	Settled Token Amount (After Tax)
reserveAmount	float?	The reserve amount held for merchants with reserves enabled.
afterReserveAmount	float?	Settled Token Amount (After Tax and Reserve)
usd	float*	USD value at time of payment
signature	string*	The fiat currency to crypto exchange process has been completed, with a unique on-chain hash.
settledAt	date*	Order Settlement Timestamp
createdAt	date*	Order Creation Timestamp
updatedAt	date*	Order Update Timestamp

---

Notes

• It works with both on-chain and off-chain payments (crypto, ramps, card, etc.)

• If no payment is found for the given signature and rampId, ok will be false

• The rampId refers to the unique merchant_transaction_id generated by the developer or merchant for a consumer.

• Please use real payment id and other params to integrate and test the API.