Payments

Get payment request link

Changed on

Returns the token behind a payment request's hosted payment link, /pay/{publicToken}. Anyone holding it can build the request's fee-sponsored payment transaction, so this route requires payment_requests.manage, not payment_requests.read. Another project's request returns 404. The token is returned whatever the request's status.

get/v1/payments/requests/{paymentRequestId}/link

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 link token

Example response

{
  "data": {
    "id": "preq_example",
    "publicToken": "example-public-token"
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes