Skip to main content

​
Overview

Use this endpoint to poll the current invoice payment status for a session (for example, to update a checkout UI while the user is paying).

​
Authentication

Requires:
  • x-session-token: pst_...
  • x-signature: sig_...

​
Request

Endpoint:
  • GET /api/v1/payments/payment-status
Playground (interactive reference): Example: 
BASE_URL=${PEPAY_API_URL}

curl "$BASE_URL/api/v1/payments/payment-status" \
  -H "x-session-token: pst_..." \
  -H "x-signature: sig_..."

​
Response

{
  "status": "unpaid",
  "paid_at": null
}
If status is underpaid, fetch session details to read the locked network/token: 
curl "$BASE_URL/api/v1/payments/session-details" \
  -H "x-session-token: pst_..." \
  -H "x-signature: sig_..."

​
Errors

  • 401 invalid session token/signature
  • 404 session not found / expired

​
Examples

  • For realtime updates, prefer WebSockets when available.
Next: Payment addresses