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://api.coindpay.xyz/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 Example

{
  "ok": true,
  "data": {
    "id": "690e31d***ba6ef8215",
    "payeeId": "1_N1yAE6DmLlv1oTd6Uoz",
    "appid": "business_app_abc123",
    "name": "David Lin",
    "email": "[email protected]",
    "payer": "0x68b37Db3E727a110B616A3d0B76195eB929Db649",
    "payMethod": "card",
    "rampId": "246159012747304960",
    "rampType": "pay",
    "rampStatus": "completed",
    "chain": "BASE",
    "symbol": "USDC",
    "fiatCoin": "AED",
    "fiatAmount": 70,
    "amount": 17.852559,
    "afterReserveAmount": 16.95987,
    "usd": 17.86,
    "signature": "0xa280113acb085e24e6de4c3f4ec3e7e53b77eca02502073145daa1ae8fec51e7",
    "settledTx": "0x23....78t4",
    "settledAt": "2025-11-07T17:55:08.220Z",
    "createdAt": "2025-11-07T17:52:17.293Z",
    "updatedAt": "2025-11-07T17:55:10.100Z"
  }
}

❌ Error Responses

404 - Not Found


cURL Request

Field Descriptions

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

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)

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.

settledTx

string?

The unique hash on the blockchain leading to the settlement process.

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.

Last updated