API Reference

Retrieve Payment Link

Retrieve a payment link by its plink_ id. The Fluveo /v1 tenant wrapper scopes the read to the active merchant; foreign or tampered ids return resource_missing.

Authentication

AuthorizationBasic

Standard Basic HTTP authentication. The username is the Fluveo secret key and the password must be empty, encoded as base64(api_key:).

OR
AuthorizationBearer

Bearer HTTP authentication. Allowed header: Authorization: Bearer <api_key>.

Path parameters

Response

Stripe-compatible response

activeboolean

Effective payable state: persisted active, future expiry, and any completion limit not exhausted.

amountinteger
createdinteger
currencystringformat: "^[a-z]{3}$"
expires_atinteger
idstringformat: "^plink_"
livemodeboolean
metadatamap from strings to strings

Payment Link merchant metadata. At most 50 entries; keys are at most 40 characters and values at most 500 characters. The case-insensitive fluveo_ namespace and payment_link key are server-reserved and rejected. Update merges entries; an empty value deletes that key.

objectenum
urlstring

The hosted page address {base}/p/{plink_id}. Carries no client_secret or key material.

after_completionobjectOptional

Returned completion behavior. redirect includes redirect.url; hosted_confirmation includes hosted_confirmation.custom_message.

descriptionstring or nullOptional<=1000 characters
inactive_messagestring or nullOptional<=500 characters
payment_method_typeslist of enums or nullOptional

Honored payment method types (spec 22745 P4, launch vocabulary: card). null = methods stay dynamic.

restrictionsobject or nullOptional

null when the link has no reuse limit. count is read-only (completed sales recorded by the ledger-bridge).

submit_typeenumOptional