Payments

Get payment request

Changed on

Retrieves one payment request in the caller's project; another project's request returns 404. Requires payment_requests.read. An open request past its expiresAt reads as expired. The record never carries publicToken; use GET /v1/payments/requests/{paymentRequestId}/link.

get/v1/payments/requests/{paymentRequestId}

Request

  • Base URL
    http://localhost:8787
  • Auth
    HTTP bearer

Path parameters

paymentRequestIdstring required

SDP payment request ID.

Example:preq_example

Headers

x-project-idstring

Required for dashboard sessions. API keys use their assigned project.

Example:prj_example

Response

Payment request

Example response

{
  "data": {
    "id": "preq_example",
    "destinationAddress": "So11111111111111111111111111111111111111112",
    "amount": "100.00",
    "reference": "So11111111111111111111111111111111111111112",
    "status": "canceled",
    "expiresAt": "2025-01-01T00:00:00.000Z",
    "lastCheckedAt": "2025-01-01T00:00:00.000Z",
    "canceledAt": "2025-01-01T00:00:00.000Z",
    "lifecycle": [
      {
        "status": "canceled",
        "at": "2025-01-01T00:00:00.000Z"
      }
    ],
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes