Skip to main content
GET
Resolve public payment page
Returns a minimal payer-facing profile for a qualified handle such as payments@acme, but only when the handle, its owning app, the public Payment policy, the per-UPA acceptance setting and the preferred settlement are all active. Account IDs, settlement addresses, KYC data, provider data and internal state are never exposed. A UPA enables its page with Turn public payment acceptance on or off.

Path Parameters

paymentHandle
string
required
Pattern: ^[a-z0-9][a-z0-9_.-]{2,39}@[a-z0-9][a-z0-9_-]{1,63}$
Example:

"payments@acme"

Response

Public payment recipient

appId
string
required
Pattern: ^app_
paymentHandle
string
required
Example:

"payments@acme"

recipient
object
required
paymentPageUrl
string<uri>
required
paymentAmount
object
required
methods
enum<string>[]
required
Available options:
crypto,
routing,
onramp
paymentTtlSeconds
integer
required
Required range: 120 <= x <= 3600
createEndpoint
string
required