Owner payments

Archive the owner payment

As the app's Archive. The owner payment drops out of default lists and totals (filter[archived] brings it back) and is read-only: other writes to it answer 409 until it is unarchived. A pending approval is cancelled. Refused (422) while a payment for it is scheduled or processing. Idempotent: archiving an archived owner payment returns it unchanged. Needs the role's Payment Requests Archive permission, and owner payment archiving turned on for the account.

post/v1/owner_payments/{owner_payment_id}/archival

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/owner_payments/{owner_payment_id}/archival
  • Auth: HTTP bearer

Path parameters

owner_payment_idstring required

Response

One owner payment.

Changes

No recorded changes to this operation across all 1 revision of this API.