Skip to main content
GET
Retrieve a payment link
Returns the full payment link object wrapped in data, including its current status and successful_payment_count.

Required scope

payment_links.read A payment link is only returned if it is accessible by your API key’s entity. Requesting a link outside your scope returns 404 not_found.

Authorizations

Authorization
string
header
required

API key passed as a bearer token. Use sk_live_ keys for production and sk_test_ keys for sandbox. Keys are provisioned during merchant onboarding.

Path Parameters

id
string<uuid>
required

The payment link ID (UUID v4).

Response

The requested payment link

data
object
required

The payment link object returned by all endpoints.