Praecise Platform
Menu

Rivier/ Reference/ shop

Record a payment received against an invoice (a bank transfer, cash)

post/invoices/{id}/payments

Record a payment received against an invoice (a bank transfer, cash); idempotent on the key. Marking an invoice paid is a person's decision.

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:write
Sdk
shop.invoice.recordPayment
Cli
shop invoice record payment

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • amountMinorintegerrequired
    At most 99999999999.
  • methodstring
    One of: manual, provider. Default: manual.
  • paymentIdstring (uuid)
  • receivedAtstring (date-time)
  • refstring
    Default: . At most 120 characters.
  • notestring
    Default: . At most 300 characters.
  • idempotencyKeystringrequired
    At most 120 characters.

Responses

  • 200application/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