Payments by reference (an order, a booking), status or page

Before you call

Credential

Authorization: Bearer $KEY

Scope

shop:read

Mcp

rivier_payments_list

Graphql

Query.payments

Sdk

shop.payment.list

Cli

shop payment list

Parameters

• referenceKindstring
  In the query
• referenceIdstring
  In the query
• statusstring
  In the query
• limitinteger
  In the query
• offsetinteger
  In the query

Responses

• 200application/json
  Success
  • itemslist of objectrequired
    • idstringrequired
    • accountIdstringrequired
    • providerRefstringrequired
    • checkoutIdstring or nullrequired
    • statusstringrequired
    • amountMinornumberrequired
    • amountReceivedMinornumberrequired
    • amountRefundedMinornumberrequired
    • feeMinornumberrequired
    • currencystringrequired
    • railLabelstring or nullrequired
    • invoiceIdstring or nullrequired
    • referenceobject or nullrequired
    • succeededAtstring or nullrequired
    • createdAtstringrequired
  • totalnumberrequired
• 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