Payments Order

Query the status and details of a specific payments order by its product id and transaction signature/rampId. This endpoint is used to verify whether a user has successfully paid for a product or membership.


API

GET /api/payment/order

Example:

GET https://coindpay.xyz/api/payment/order?signature=0xabc123

Query Params

Name
Type
Required
Description

rampId

string?

Optional

Unique fiat currency merchant_transaction_id

signature

string?

Optional

Unique transaction on-chain tx signature

  1. At least one of the two params — rampId or signature — must be provided when initiating a payment order transaction.

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

  3. 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.


Response

✅ 200 - Success

{
  "ok": true,
  "data": {
    "id": "payment_abc123",
    "payeeId": "plan_xyz123",
    "rampId": "xxx-sss",
    "rampStatus": "completed",
    "rampType": "buy",
    "signature": "0xabc123",
    "uuid": "user_xyz987",
    "payer": "0xabcde1234",
    "payMethod": "Visa",
    "name": "Alice",
    "email": "[email protected]",
    "message": "Monthly plan",
    "chain": "solana",
    "chainId": 101,
    "amount": 18.5,
    "usd": 9.99,
    "contract": "So11111111111111111111111111111111111111112",
    "symbol": "USDC",
    "fiatCoin": "USD",
    "fiatAmount": 9.99,
    "createdAt": "2025-06-29T03:10:00Z"
  }
}

❌ Error Responses

404 - Not Found

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

cURL Request

curl "https://coindpay.xyz/api/payment/order?rampId=plan_xyz123

Field Descriptions

Field
Type
Description

id

string*

Unique payment ID

payeeId

string*

Product or service ID

signature

string*

Unique transaction hash or order reference

rampId

string?

Order ID that is paid for through Ramps service provider

rampStatus

string?

Order status of payment completed through Ramps service provider

rampType

string?

Payment type (buy or sell) completed through Ramps service provider

uuid

string?

Internal ID of the payee (receiver)

payer

string?

Wallet address (for crypto payments)

payMethod

string?

Fiat payment provider name (e.g., Card)

name

string?

Name of the payer (optional)

email

string?

Email of the payer (optional)

message

string?

Optional payment message

chain

string?

Blockchain name (e.g., solana, ethereum)

chainId

number?

Chain ID used for payment

amount

number*

Amount paid in token

usd

number*

USD value at time of payment

contract

string?

Contract address of the token

symbol

string*

Token symbol (e.g., USDT, USDC)

fiatCoin

string?

Fiat currency code (e.g., USD)

fiatAmount

number?

Fiat amount paid (if any)

createdAt

string*

ISO 8601 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

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

Last updated