GET /v1/payment/{id}

Returns the current status and details of a payment. Requires authentication.

Request

GET /v1/payment/{payment_id}

Example

curl https://api.nearpayments.io/v1/payment/1 \
  -H "x-api-key: YOUR_API_KEY"

Payment Statuses

Status	Description
`waiting`	Awaiting payment
`confirming`	Transaction detected, waiting for confirmations
`confirmed`	Confirmed on-chain
`sending`	Converting and sending to merchant
`finished`	Payment complete
`partially_paid`	Buyer sent less than required
`failed`	Payment failed
`refunded`	Payment was refunded
`expired`	Payment expired (24h default)

Response

{
  "payment_id": 1,
  "payment_status": "finished",
  "pay_address": "bc1q...",
  "price_amount": 25.50,
  "price_currency": "usd",
  "pay_amount": 0.00029,
  "actually_paid": 0.00029,
  "pay_currency": "btc",
  "order_id": "order-42",
  "order_description": null,
  "purchase_id": 5234123456,
  "outcome_amount": 25.50,
  "outcome_currency": "usdc",
  "invoice_id": null,
  "payin_extra_id": null,
  "payin_hash": null,
  "payout_hash": null,
  "burning_percent": "null",
  "type": "crypto2crypto",
  "created_at": "2025-01-15T10:30:00.000Z",
  "updated_at": "2025-01-15T10:35:00.000Z"
}