Payments

Create a payment link (Checkout Session)

Creates a Stripe Checkout Session and returns a one-time hosted payment URL.

Funds-flow modes

Mode	When	Who is charged	Oriva fee
Direct Charge	merchant_connect_account_id present	Buyer charged via merchant Connect account	10% application_fee_amount deducted at charge time. funds_flow=direct_charge written to session metadata.
Separate Transfers	merchant_connect_account_id absent	Buyer charged on Oriva platform account	REA cron distributes author share post-settlement. funds_flow=separate_transfers written to session metadata.

The funds_flow field in the Stripe metadata is set automatically by the server based on the presence of merchant_connect_account_id — callers do not set it.

Requires an active oriva_pk_ API key whose owner has a registered REA agent record.

post/api/v1/payments/payment-links

Request

Base URL: https://api.oriva.io
URL: https://api.oriva.io/api/v1/payments/payment-links
Auth: HTTP bearer

Request body

amount_centsinteger required

Charge amount in the smallest currency unit (e.g. cents for USD). Range 1–99,999,999.

currencystring required

ISO 4217 three-letter currency code (e.g. "usd").

descriptionstring

Product description shown on the Stripe Checkout page.

merchant_connect_account_idstring

Stripe Connect account ID (format: acct_…). When present the session runs as a Direct Charge: Stripe charges the buyer via the merchant account; Oriva collects a 10% application fee. When absent the session falls back to Separate Transfers: Oriva charges on the platform account and distributes via the REA payout cron.

oriva_manifest_idstring uuid

REA manifest UUID for skill royalty attribution.

oriva_invocation_idstring uuid

Unique invocation UUID for analytics and deduplication.

success_urlstring uri required

URL the buyer is redirected to after a successful payment. Must use https://.

cancel_urlstring uri required

URL the buyer is redirected to if they abandon the checkout. Must use https://.

metadataobject

Arbitrary key-value pairs forwarded to the Stripe Checkout Session metadata.

Response

Checkout Session created. Redirect the buyer to data.url.

oktrue required

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.