Canopy Reversals API
Reverse payments/draws on a line of credit for your customers in Canopy.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/canopyservicing-com:canopyservicing-com-reversals-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Canopy Servicing Core Reversals 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: Reversals
description: Reverse payments/draws on a line of credit for your customers in Canopy.
paths:
/revolving/v1/accounts/{account_id}/line_of_credit/{line_of_credit_id}/payment_reversals/{payment_id}:
post:
tags:
- Reversals
summary: Reverse a payment on a line of credit
description: Reverses a payment on a line of credit.
operationId: ReversalCBV_reverse_payment_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__payment_reversals__payment_id__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
- name: payment_id
in: path
required: true
schema:
type: string
description: ID of the Payment to reverse
title: Payment Id
description: ID of the Payment to reverse
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReverseTransactionSchema'
description: Payment reversal parameters
responses:
'202':
description: Returns the created payment reversal
content:
application/json:
schema:
$ref: '#/components/schemas/ReversePaymentResponse'
'404':
description: Entity not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrNotFoundSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'500':
description: A server error has occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrServerErrorSchema'
/revolving/v1/accounts/{account_id}/line_of_credit/{line_of_credit_id}/draw_reversals/{draw_id}:
post:
tags:
- Reversals
summary: Reverse a draw on a line of credit
description: Reverses a draw on a line of credit.
operationId: ReversalCBV_reverse_draw_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__draw_reversals__draw_id__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
- name: draw_id
in: path
required: true
schema:
type: string
description: ID of the Draw to reverse
title: Draw Id
description: ID of the Draw to reverse
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReverseTransactionSchema'
description: Draw reversal parameters
responses:
'202':
description: Returns the created draw reversal
content:
application/json:
schema:
$ref: '#/components/schemas/ReverseDrawResponse'
'404':
description: Entity not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrNotFoundSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'500':
description: A server error has occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrServerErrorSchema'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
ReverseDrawResponse:
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
reversal_id:
type: string
title: Reversal Id
description: The ID of the reversal.
hidden: false
reversed_draw_id:
type: string
title: Reversed Draw Id
description: The ID of the draw that was reversed.
hidden: false
type: object
required:
- account_id
- line_of_credit_id
- effective_at
- issued_at
- reversal_id
- reversed_draw_id
title: ReverseDrawResponse
description: Response schema for the reverse draw endpoint.
ReversePaymentResponse:
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
reversal_id:
type: string
title: Reversal Id
description: The ID of the reversal.
hidden: false
reversed_payment_id:
type: string
title: Reversed Payment Id
description: The ID of the payment that was reversed.
hidden: false
type: object
required:
- account_id
- line_of_credit_id
- effective_at
- issued_at
- reversal_id
- reversed_payment_id
title: ReversePaymentResponse
description: Response schema for the reverse payment endpoint.
ErrNotFoundSchema:
properties:
message:
type: string
title: Message
description: The error message
examples:
- Entity not found.
type: object
required:
- message
title: ErrNotFoundSchema
ErrServerErrorSchema:
properties:
message:
type: string
title: Message
description: The error message
examples:
- A server error has occurred.
type: object
required:
- message
title: ErrServerErrorSchema
ReverseTransactionSchema:
properties: {}
type: object
title: ReverseTransactionSchema
description: Request schema for reversing a payment/draw on a line of credit.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer