Praecise Platform
Menu

Rivier/ Reference/ shop

Ask for a refund

post/payments/refunds

Ask for a refund. It waits for a person's approval; the limits of the money policy apply.

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:write
Mcp
rivier_payments_refund_request
Graphql
Mutation.requestRefund
Sdk
shop.refund.request
Cli
shop refund request
Events
shop.refund.requested

Request bodyapplication/json, required

  • paymentIdstring (uuid)required
  • amountMinorinteger
    At most 99999999999.
  • currencystring
    Pattern: ^[a-z]{3}$.
  • reasonstring
    Default: . At most 300 characters.
  • 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