Praecise Platform
Menu

Rivier/ Reference/ shop

Shop checkout create

post/payments/checkouts

Open a checkout for any reference (an order, a booking, an invoice, or your own id as other): the payment carries the reference and the payment events name it. Repeat with the same idempotency key to get the same checkout.

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:write
Mcp
rivier_payments_checkout_create
Graphql
Mutation.shopCheckoutCreate
Sdk
shop.checkout.create
Cli
shop checkout create

Request bodyapplication/json, required

  • referenceobjectrequired
    • kindstringrequired
      One of: order, booking, invoice, reservation, link, other.
    • idstringrequired
      At most 120 characters.
  • amountMinorintegerrequired
    At most 99999999999.
  • currencystringrequired
    Pattern: ^[a-z]{3}$.
  • lineslist of object
    Default: [].
    • namestringrequired
      At most 200 characters.
    • quantityintegerrequired
      At least 1. At most 100000.
    • unitAmountMinorintegerrequired
      At least 0. At most 99999999999.
  • customerobject
    Default: {}.
    • emailstring (email)
    • namestring
      At most 160 characters.
  • successUrlstring (uri)
    At most 2000 characters.
  • cancelUrlstring (uri)
    At most 2000 characters.
  • expiresAtstring (date-time)
  • capturestring
    One of: automatic, manual. Default: automatic.
  • saveMethodboolean
    Default: false.
  • formstring
    One of: hosted, embedded, headless. Default: hosted.
  • idempotencyKeystringrequired
    At most 120 characters.

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown