Benji Pays Organization API

openapi: 3.2.0
info:
  title: Benji Pays Merchant Organization API
  description: 'The Benji Pays Merchant API is a JSON over HTTPS API. All endpoints live under `/v2`. Errors follow RFC 7807 and are served as `application/problem+json`. This overview describes the cross-cutting behavior shared by every merchant endpoint. Endpoint-specific schemas live with each operation. ## Authentication


    Merchant endpoints authenticate with an organization-scoped `x-api-key` header issued from the merchant app:


    ```

    x-api-key:

    ```


    The key is scoped to one organization and inherits the permissions of the login that created it. Failures return `401 Unauthorized` (missing/expired/invalid credentials) or `403 Forbidden` (insufficient mapping permission or organization lifecycle restrictions). ## Request and Correlation IDs


    Two header pairs help with tracing:


    | Header | Direction | Purpose |

    | --- | --- | --- |

    | `X-Request-ID` | request (optional) / response (always) | Unique identifier for one request. Generated as a UUID v4 when the client omits it. |

    | `X-Correlation-ID` | request (optional) / response (always) | Identifier that flows across service boundaries for distributed tracing. Generated as a UUID v4 when omitted. |


    Both IDs are echoed on success and included as `requestId` / `correlationId` extensions on `application/problem+json` error responses. These headers are auto-injected on every operation in this spec — do not redeclare them per route. ## Idempotency


    POST, PATCH, and PUT endpoints accept an `Idempotency-Key` header to make retries safe. - Format: 1–255 characters, alphanumeric only (`[a-zA-Z0-9]+`). - Scope: keys are scoped per actor (no cross-tenant collisions). - Cache: the first response for a given key is cached for 24 hours. - Replay: a duplicate request with the same key and the same body returns the cached response with `X-Idempotency-Replayed: true` only after credentials were resolved by the global authenticate middleware (API key or Auth0 JWT signature check) before the idempotency cache lookup. - Conflict: same key with a different body returns `409 Conflict`. - In-flight: a second request with the same key while the first is still being processed returns `429 Too Many Requests` with `Retry-After` and problem `type` `https://api.benjipays.com/problems/idempotency-processing` (distinct from rate-limit `…/rate-limit-exceeded`). `Idempotency-Key` is auto-injected on every POST/PATCH/PUT operation in this spec — do not redeclare it per route. Routes that intentionally opt out set `x-bp-skip-idempotency: true`. The middleware fails open: if the cache layer is unavailable the request proceeds without idempotency protection. Most write routes treat the header as optional. Routes that require it set `x-bp-require-idempotency: true` and return `400 Bad Request` when it is missing — currently `POST /v2/transactions`, `POST /v2/transactions/prepayments`, and `POST /v2/transactions/{transactionId}/retry-accounting`. Those routes are also the exception to the fail-open rule above: when the cache layer is unavailable they return `503 Service Unavailable` with `Retry-After` and problem `type` `https://api.benjipays.com/problems/idempotency-unavailable`, and the request is not processed. Retry with the same key. The two charge routes (`POST /v2/transactions` and `POST /v2/transactions/prepayments`) also save the key on the charge. Recover a charge with `GET /v2/transactions?idempotencyKey={key}` (empty `data` when the key was never used). After the 24-hour replay window, the same key creates a new charge. ## Pagination


    List endpoints use offset-based pagination with two query parameters:


    | Parameter | Type | Default | Bounds |

    | --- | --- | --- | --- |

    | `limit` | integer | `20` | `1`–`1000` |

    | `offset` | integer | `0` | `≥ 0` |


    Some endpoints use different bounds (for example usage/billing and autoprocessing forecast). Check the per-operation schema.'
  version: 2.0.0
  contact:
    name: Benji Pays API Support
    email: benji@benjipays.com
servers:
- url: https://api.benjipays.com
  description: Development server
security:
- ApiKeyAuth: []
tags:
- name: Organization
  description: Profile (company details) for the authenticated organization
paths:
  /v2/organization:
    get:
      summary: Get profile for an Organization
      description: Returns the normalized profile for the organization associated with the authenticated API key.
      tags:
      - Organization
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Successful response with organization profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationProfileResponse'
        '401':
          description: Unauthorized — invalid or missing authentication, or organization is not active.
          content:
            application/problem+json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: number
                  detail:
                    type: string
                  instance:
                    type: string
                required:
                - type
                - title
                - status
                - detail
                additionalProperties: false
                description: Error response (RFC 7807 Problem Details)
                examples:
                  invalidToken:
                    summary: Invalid or missing authentication
                    value:
                      type: https://api.benjipays.com/problems/unauthorized
                      title: Unauthorized
                      status: 401
                      detail: Invalid or missing authentication token
                      instance: /v2/organization
                  organizationNotActive:
                    summary: Organization is not active
                    value:
                      type: https://api.benjipays.com/problems/unauthorized
                      title: Unauthorized
                      status: 401
                      detail: API access is not active for this organization
                      instance: /v2/organization
        '403':
          description: Forbidden — missing required scope (`organizations:profile:read`), insufficient mapping permission (`companyAdmin` required), or free trial ended without billing.
          content:
            application/problem+json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: number
                  detail:
                    type: string
                  instance:
                    type: string
                required:
                - type
                - title
                - status
                - detail
                additionalProperties: false
                description: Error response (RFC 7807 Problem Details)
                examples:
                  missingScope:
                    summary: Missing OAuth scope
                    value:
                      type: https://api.benjipays.com/problems/forbidden
                      title: Forbidden
                      status: 403
                      detail: 'Missing required scope: organizations:profile:read'
                      instance: /v2/organization
                  insufficientPermission:
                    summary: Insufficient mapping permission
                    value:
                      type: https://api.benjipays.com/problems/forbidden
                      title: Forbidden
                      status: 403
                      detail: Insufficient permission for this resource
                      instance: /v2/organization
        '429':
          description: Too Many Requests — rate limit exceeded.
          content:
            application/problem+json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: number
                  detail:
                    type: string
                  instance:
                    type: string
                required:
                - type
                - title
                - status
                - detail
                additionalProperties: false
                description: Error response (RFC 7807 Problem Details)
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CorrelationIdHeader'
      operationId: getV2Organization
      x-operation-id-source: derived
components:
  schemas:
    OrganizationProfileResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            name:
              anyOf:
              - type: string
              - type: 'null'
            emailAddress:
              anyOf:
              - type: string
              - type: 'null'
            phone:
              anyOf:
              - type: string
              - type: 'null'
            website:
              anyOf:
              - type: string
              - type: 'null'
            enabled:
              type: boolean
            createdDate:
              anyOf:
              - type: string
              - type: 'null'
            accountingType:
              anyOf:
              - type: string
              - type: 'null'
            timeZone:
              anyOf:
              - type: string
              - type: 'null'
            accountingCompanyId:
              anyOf:
              - type: string
              - type: 'null'
            address:
              anyOf:
              - type: string
              - type: 'null'
            city:
              anyOf:
              - type: string
              - type: 'null'
            country:
              anyOf:
              - type: string
              - type: 'null'
            postal:
              anyOf:
              - type: string
              - type: 'null'
            province:
              anyOf:
              - type: string
              - type: 'null'
            homeCurrency:
              anyOf:
              - type: string
              - type: 'null'
            gstNumber:
              anyOf:
              - type: string
              - type: 'null'
            logo:
              anyOf:
              - type: object
                properties:
                  location:
                    anyOf:
                    - type: string
                    - type: 'null'
                  key:
                    anyOf:
                    - type: string
                    - type: 'null'
                  width:
                    anyOf:
                    - type: number
                    - type: 'null'
                  height:
                    anyOf:
                    - type: number
                    - type: 'null'
                  extension:
                    anyOf:
                    - type: string
                    - type: 'null'
                  mimetype:
                    anyOf:
                    - type: string
                    - type: 'null'
                  size:
                    anyOf:
                    - type: number
                    - type: 'null'
                required:
                - location
                - key
                - width
                - height
                - extension
                - mimetype
                - size
                additionalProperties: false
              - type: 'null'
            accountingCompanyInfo:
              anyOf:
              - type: object
                propertyNames:
                  type: string
                additionalProperties: {}
              - type: 'null'
              description: Raw company info from the connected accounting system. The shape is system-specific and NOT normalized (QuickBooks Online, Xero, Business Central, and QuickBooks Desktop each return a different structure). Passed through as-is.
          required:
          - id
          - name
          - emailAddress
          - phone
          - website
          - enabled
          - createdDate
          - accountingType
          - timeZone
          - accountingCompanyId
          - address
          - city
          - country
          - postal
          - province
          - homeCurrency
          - gstNumber
          - logo
          - accountingCompanyInfo
          additionalProperties: false
      required:
      - data
      additionalProperties: false
      description: Organization profile response
  parameters:
    CorrelationIdHeader:
      name: X-Correlation-ID
      in: header
      required: false
      description: Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.
      schema:
        type: string
        format: uuid
    RequestIdHeader:
      name: X-Request-ID
      in: header
      required: false
      description: Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.
      schema:
        type: string
        format: uuid
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Organization-scoped API key. Send it in the x-api-key header. Available on organization endpoints only.
x-speakeasy-retries:
  strategy: backoff
  backoff:
    initialInterval: 500
    maxInterval: 60000
    maxElapsedTime: 3600000
    exponent: 1.5
  statusCodes:
  - 5XX
  retryConnectionErrors: true
x-provenance:
  method: searched
  source: https://developer.benjipays.com/reference
  harvested: '2026-11-02'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.benjipays.com/reference/delete_v2-customers-customerid-alert.md
  - https://developer.benjipays.com/reference/delete_v2-customers-customerid-notes-noteid.md
  - https://developer.benjipays.com/reference/get_v2-accounting-accounts.md
  - https://developer.benjipays.com/reference/get_v2-autoprocessing-forecast.md
  - https://developer.benjipays.com/reference/get_v2-customers-customerid-notes-noteid.md
  - https://developer.benjipays.com/reference/get_v2-customers-customerid-notes.md
  - https://developer.benjipays.com/reference/get_v2-customers-customerid.md
  - https://developer.benjipays.com/reference/get_v2-customers.md
  - https://developer.benjipays.com/reference/get_v2-emails-emailid.md
  - https://developer.benjipays.com/reference/get_v2-emails.md
  - https://developer.benjipays.com/reference/get_v2-gateways-capabilities.md
  - https://developer.benjipays.com/reference/get_v2-gateways.md
  - https://developer.benjipays.com/reference/get_v2-invoices-invoiceid-pdf.md
  - https://developer.benjipays.com/reference/get_v2-invoices-invoiceid.md
  - https://developer.benjipays.com/reference/get_v2-invoices.md
  - https://developer.benjipays.com/reference/get_v2-notes-categories.md
  - https://developer.benjipays.com/reference/get_v2-notes-statuses.md
  - https://developer.benjipays.com/reference/get_v2-organization.md
  - https://developer.benjipays.com/reference/get_v2-payment-method-requests-paymentmethodrequestid.md
  - https://developer.benjipays.com/reference/get_v2-payment-method-requests.md
  - https://developer.benjipays.com/reference/get_v2-payment-methods-id.md
  - https://developer.benjipays.com/reference/get_v2-payment-methods.md
  - https://developer.benjipays.com/reference/get_v2-settings.md
  - https://developer.benjipays.com/reference/get_v2-transactions-transactionid-receipt.md
  - https://developer.benjipays.com/reference/get_v2-transactions.md
  - https://developer.benjipays.com/reference/get_v2-users.md
  - https://developer.benjipays.com/reference/get_v2-whoami-1.md
  - https://developer.benjipays.com/reference/patch_v2-customers-customerid-notes-noteid.md
  - https://developer.benjipays.com/reference/patch_v2-customers-customerid.md
  - https://developer.benjipays.com/reference/post_v2-customers-customerid-alert.md
  - https://developer.benjipays.com/reference/post_v2-customers-customerid-notes-noteid-replies.md
  - https://developer.benjipays.com/reference/post_v2-customers-customerid-notes-noteid-status.md
  - https://developer.benjipays.com/reference/post_v2-customers-customerid-notes.md
  - https://developer.benjipays.com/reference/post_v2-payment-links-applied-invoiceid.md
  - https://developer.benjipays.com/reference/post_v2-payment-links-unapplied.md
  - https://developer.benjipays.com/reference/post_v2-payment-method-requests.md
  - https://developer.benjipays.com/reference/post_v2-transactions-prepayments.md
  - https://developer.benjipays.com/reference/post_v2-transactions-transactionid-resend-receipt.md
  - https://developer.benjipays.com/reference/post_v2-transactions-transactionid-retry-accounting.md
  - https://developer.benjipays.com/reference/post_v2-transactions.md
  merge:
    pages: 40
    deduped: 167
    conflicts_kept_first: 0