Refunds by state or payment

Before you call

Credential

Authorization: Bearer $KEY

Scope

shop:read

Mcp

rivier_payments_refunds_list

Graphql

Query.refunds

Sdk

shop.refund.list

Cli

shop refund list

Parameters

• statestring
  In the query
• paymentIdstring (uuid)
  In the query
• limitinteger
  In the query

Responses

• 200application/json
  Success
  • refundslist of objectrequired
    • idstringrequired
    • paymentIdstringrequired
    • amountMinornumberrequired
    • currencystringrequired
    • reasonstringrequired
    • statestringrequired
    • requestedBystringrequired
    • approvedBystring or nullrequired
    • errorstring or nullrequired
    • executedAtstring or nullrequired
    • createdAtstringrequired
• 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