evictionsapi-com Payment Methods API

openapi: 3.2.0
info:
  title: Evictionsapi Com Payment Methods API
  version: 0.0.0
  contact:
    email: hello@evictionsapi.com
  description: 'Operations tagged Payment Methods across 3 of this provider''s published API definitions: api.evictionsapi.com.json, evictionsapi-com-api-evictions-openapi.json, evictionsapi-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.evictionsapi.com
tags:
- name: Payment Methods
paths:
  /v1/payment-methods:
    get:
      summary: The organization's saved cards for the automatic charges of full-service cases…
      security:
      - ApiKey: []
      - SessionToken: []
      responses:
        '200':
          description: The cards.
          content:
            application/json:
              schema:
                type: object
                required:
                - items
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Card'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person''s role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Payment Methods
      operationId: getV1PaymentMethods
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
  /v1/payment-methods/setup:
    post:
      summary: Open the payment provider's page for adding a card.
      security:
      - ApiKey: []
      - SessionToken: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                returnPath:
                  type: string
                  maxLength: 200
                  pattern: ^\/app(\/[A-Za-z0-9_-]+)*$
                default:
                  type: boolean
              required:
              - returnPath
              additionalProperties: false
      responses:
        '200':
          description: The URL to send the customer to.
          content:
            application/json:
              schema:
                type: object
                required:
                - url
                properties:
                  url:
                    type: string
                    format: uri
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person''s role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Payment Methods
      operationId: postV1PaymentMethodsSetup
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
  /v1/payment-methods/confirm:
    post:
      summary: Add the card of a finished setup to the organization's cards in this mode.
      security:
      - ApiKey: []
      - SessionToken: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                sessionId:
                  type: string
                  minLength: 1
                  maxLength: 255
                default:
                  type: boolean
              required:
              - sessionId
              additionalProperties: false
      responses:
        '200':
          description: The card.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Card'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person''s role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Payment Methods
      operationId: postV1PaymentMethodsConfirm
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
  /v1/payment-methods/{id}:
    patch:
      summary: Name a card (`label`, null to clear it) or make it the default (`default…
      security:
      - ApiKey: []
      - SessionToken: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  anyOf:
                  - type: string
                    minLength: 1
                    maxLength: 60
                  - type: 'null'
                default:
                  type: boolean
                  const: true
              additionalProperties: false
      responses:
        '200':
          description: The card as it now is.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Card'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person''s role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Payment Methods
      operationId: patchV1PaymentMethodsById
      x-operation-id-source: derived
    delete:
      summary: 'Remove a card: it is detached at the payment provider and never charged again.'
      security:
      - ApiKey: []
      - SessionToken: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The card is removed.
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person''s role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Payment Methods
      operationId: deleteV1PaymentMethodsById
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - details
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
    Card:
      type: object
      description: 'One of the organization''s saved cards for the automatic charges of full-service cases, in the key''s mode. The card number is never stored: only its brand and last four. A case is charged to the card it names (`paymentMethodId`), else to the default card. `failed`: the card was declined; it is not charged again, and cannot be made the default.'
      required:
      - id
      - brand
      - lastFour
      - status
      - label
      - isDefault
      - addedBy
      - createdAt
      properties:
        id:
          type: string
        brand:
          type:
          - string
          - 'null'
        lastFour:
          type:
          - string
          - 'null'
        status:
          enum:
          - usable
          - failed
        label:
          type:
          - string
          - 'null'
          description: What the organization calls the card, such as "Operating account card"; null when unnamed.
        isDefault:
          type: boolean
          description: The card charged when a case names none. One card per mode at most.
        addedBy:
          type:
          - object
          - 'null'
          required:
          - id
          - name
          properties:
            id:
              type: string
            name:
              type:
              - string
              - 'null'
          description: The person who added it; null for a card added with an API key, or before this was kept.
        createdAt:
          type: string
          format: date-time
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: An organization API key (`eak_test_...` or `eak_live_...`).
    SessionToken:
      type: http
      scheme: bearer
      description: 'A session token (`ess_...`) from `POST /v1/auth/signup` or `/v1/auth/login`, valid for 30 days. On the case, webhook, API key and organization routes it acts for the organization the session is in (`POST /v1/me/organization` switches it) in the mode named by the `X-Evictions-Mode` header: `test` (the default) or `live`.'
    AttorneyToken:
      type: http
      scheme: bearer
      description: A user token (`eut_...`) of a verified attorney.
externalDocs:
  url: https://evictionsapi.com/docs
x-refined-from:
- api.evictionsapi.com.json
- evictionsapi-com-api-evictions-openapi.json
- evictionsapi-com-openapi.json