Payments

List payment requests

Needs comms_read. Lists your most recent payment requests, newest first. There's no pagination. The Payments API is off until an owner or admin accepts the merchant terms. Until then, this returns 403 payments_api_disabled. This still works while payments are suspended.

get/payments

Request

Base URL: https://osis.co/api/v1/comms
URL: https://osis.co/api/v1/comms/payments
Auth: HTTP bearer

Query parameters

status'pending' | 'paid' | 'canceled' | 'partially_refunded' | 'refunded'

limitinteger

How many to return. Max 200.

Response

Your payment requests.

Example response

{
  "payment_requests": [
    {
      "id": "payreq_123",
      "currency": "usd"
    }
  ]
}

Changes

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