Canopy Offsets API

openapi: 3.2.0
info:
  title: Canopy Servicing Core Offsets API
  description: 'Canopy allows you to easily manage credit, installment, or other more complex lending programs from a servicing and compliance perspective -

    whether newly launched or migrated from existing systems. using canopy, you can track balances and transactions for each customer of your product, both in real-time and historically.

    You can see how various policy and product changes would impact your customers, and readily generate compliance reports and minimize your risk with all real-time information always on hand.

    Canopy additionally surfaces information around all of your lending activity through its intuitive ui which provides a customer support interface as well as at-a-glance data needed for compliance and insights.

    Simply configure your product`s policies through our create product api endpoint, and then you can immediately begin adding customer accounts and relying on canopy for accurate servicing information.'
  contact:
    name: Canopy Support
    url: https://www.canopyservicing.com/contact
    email: support@canopyservicing.com
  version: 1.0.0
servers:
- url: Contact sales to enable your sandbox
  description: Your private sandbox environment
- url: https://demo-api.us.canopyservicing.com
  description: Demo environment
tags:
- name: Offsets
  description: Manage offsets on a line of credit for your customers in Canopy.
paths:
  /revolving/v1/accounts/{account_id}/line_of_credit/{line_of_credit_id}/offset:
    post:
      tags:
      - Offsets
      summary: Create an offset for a line of credit
      description: Creates a new offset for a line of credit.
      operationId: OffsetCBV_create_offset_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__offset_post
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      - name: line_of_credit_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the Line of Credit
          title: Line Of Credit Id
        description: ID of the Line of Credit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOffsetSchema'
              description: Offset creation parameters
      responses:
        '201':
          description: Returns the created offset
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOffsetResponse'
        '400':
          description: Your request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBadRequestSchema'
        '404':
          description: Entity not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrNotFoundSchema'
        '409':
          description: Entity already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrConflictSchema'
        '422':
          description: Your request failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrValidationErrorSchema'
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
components:
  schemas:
    CreateOffsetResponse:
      properties:
        account_id:
          type: string
          title: Account Id
          description: The account id.
          hidden: false
        line_of_credit_id:
          type: string
          title: Line Of Credit Id
          description: The line of credit id.
          hidden: false
        effective_at:
          type: string
          title: Effective At
          description: The effective at date.
          hidden: false
        issued_at:
          type: string
          title: Issued At
          description: The issued at date.
          hidden: false
        status:
          anyOf:
          - additionalProperties: true
            type: object
          - items:
              additionalProperties: true
              type: object
            type: array
          - items: {}
            type: array
          title: Status
          description: The status of the entity.
          hidden: false
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - items:
              additionalProperties: true
              type: object
            type: array
          - items: {}
            type: array
          title: Metadata
          description: The metadata of the entity.
          hidden: false
        offset_id:
          type: string
          title: Offset Id
          description: The ID of the offset.
          hidden: false
        offset_type:
          type: string
          title: Offset Type
          description: The type of offset.
          hidden: false
        original_amount_cents:
          type: integer
          title: Original Amount Cents
          description: The original amount in cents of the offset.
          hidden: false
        allocation:
          $ref: '#/components/schemas/OffsetAllocation'
          description: The allocation of the offset.
      type: object
      required:
      - account_id
      - line_of_credit_id
      - effective_at
      - issued_at
      - offset_id
      - offset_type
      - original_amount_cents
      title: CreateOffsetResponse
      description: Response schema for the create offset endpoint.
    CreateOffsetSchema:
      properties:
        offset_id:
          type: string
          title: Offset Id
          description: The ID associated to be with the offset for future requests. If not provided on offset creation, Canopy will generate this field.
          examples:
          - offset_1
        amount_cents:
          type: integer
          title: Amount Cents
          description: The amount of the offset
          examples:
          - -100000
          hidden: false
        offset_type:
          $ref: '#/components/schemas/OffsetEntityType'
          description: The type of offset to create
          examples:
          - REBATE
          hidden: false
        allocation:
          $ref: '#/components/schemas/OffsetAllocation'
          description: The allocation type of the offset
          examples:
          - PRINCIPAL
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - items:
              additionalProperties: true
              type: object
            type: array
          - items: {}
            type: array
          maxLength: 100
          title: Metadata
          description: Metadata that can be associated with the offset
      type: object
      required:
      - amount_cents
      - offset_type
      title: CreateOffsetSchema
      description: Request schema for creating an offset on a line of credit.
    OffsetEntityType:
      type: string
      enum:
      - REBATE
      - COLLATERAL_LIQUIDATION
      - COLLATERAL_RELEASE_CREDIT
      title: OffsetEntityType
    ErrBadRequestSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Your request is invalid.
      type: object
      required:
      - message
      title: ErrBadRequestSchema
    ErrValidationErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Your request failed validation.
      type: object
      required:
      - message
      title: ErrValidationErrorSchema
    ErrNotFoundSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Entity not found.
      type: object
      required:
      - message
      title: ErrNotFoundSchema
    ErrConflictSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Entity already exists.
      type: object
      required:
      - message
      title: ErrConflictSchema
    OffsetAllocation:
      type: string
      enum:
      - PRINCIPAL
      - INTEREST
      - FEES
      title: OffsetAllocation
    ErrServerErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - A server error has occurred.
      type: object
      required:
      - message
      title: ErrServerErrorSchema
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer