Skip to main content
GET
/
pay
/
{slug}
Open or settle a payment link
curl --request GET \
  --url https://api.sumvin.com/pay/{slug}
{
  "_links": {
    "canonical": {
      "href": "/v0/payment-links/public/q79Rx34K"
    },
    "self": {
      "href": "/pay/q79Rx34K"
    }
  },
  "network": "eip155:1329",
  "payer": "0xcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd",
  "receipt_url": "/v0/payment-links/public/q79Rx34K",
  "success": true,
  "transaction": "0xabababababababababababababababababababababababababababababababab"
}

Headers

accept
string | null
PAYMENT-SIGNATURE
string | null
X-Timestamp-Format
string

Controls how timestamp fields are serialized in JSON response bodies.

Default (header omitted or any other value): epoch milliseconds as integers. iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.

Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".

Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.

Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.

Example:

"iso8601"

Path Parameters

slug
string
required

Response

Browser landing (HTML) or settlement receipt (JSON) for an agent retry. The body's media type follows the caller's Accept header.

Body returned after a successful (or declined) settlement attempt.

success
boolean
required

True if the submitted payment was accepted and settled.

network
string
required

CAIP-2 network identifier on which settlement was processed.

HAL-style hypermedia links for navigation and available actions.

transaction
string | null

On-chain transaction hash once settlement is finalized.

payer
string | null

Wallet address that settled the payment, when known.

receipt_url
string | null

URL where a receipt for this settlement can be retrieved.