Canopy · Schema
CreateBalanceTransferSchema
Request schema for creating a balance transfer on a line of credit.
CompanyB2BLoan ManagementFintechAPI Platform
Properties
| Name | Type | Description |
|---|---|---|
| draw_id | string | ID to associate with the draw. If not provided, Canopy will generate one. |
| card_id | string | ID of the card associated with the balance transfer. |
| amount_cents | integer | Amount to transfer in cents |
| settlement_status | object | Settlement status of the draw. |
| interest_rate_percent | object | Annual interest rate for the draw as a whole number (e.g., 5.0 for 5%) |
| metadata | object | Metadata to associate with the draw |
| fee | object | Fee to create atomically with the balance transfer |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/canopyservicing-com/json-schema/canopyservicing-com-create-balance-transfer-schema-schema.json",
"title": "CreateBalanceTransferSchema",
"description": "Request schema for creating a balance transfer on a line of credit.",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/canopyservicing-com-draws-api-openapi.yml#/components/schemas/CreateBalanceTransferSchema",
"properties": {
"draw_id": {
"type": "string",
"title": "Draw Id",
"description": "ID to associate with the draw. If not provided, Canopy will generate one."
},
"card_id": {
"type": "string",
"title": "Card Id",
"description": "ID of the card associated with the balance transfer."
},
"amount_cents": {
"type": "integer",
"title": "Amount Cents",
"description": "Amount to transfer in cents",
"hidden": false
},
"settlement_status": {
"$ref": "#/$defs/TransactionStatusTypeStatuses",
"description": "Settlement status of the draw.",
"default": "SETTLED",
"hidden": false
},
"interest_rate_percent": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"title": "Interest Rate Percent",
"description": "Annual interest rate for the draw as a whole number (e.g., 5.0 for 5%)",
"hidden": false
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"items": {},
"type": "array"
}
],
"maxLength": 100,
"title": "Metadata",
"description": "Metadata to associate with the draw"
},
"fee": {
"$ref": "#/$defs/BalanceTransferFeeInput",
"description": "Fee to create atomically with the balance transfer",
"hidden": false
}
},
"type": "object",
"required": [
"amount_cents",
"fee"
],
"$defs": {
"BalanceTransferFeeInput": {
"properties": {
"fee_id": {
"type": "string",
"title": "Fee Id",
"description": "ID for the fee. If not provided, Canopy will generate one."
},
"amount_cents": {
"type": "integer",
"title": "Amount Cents",
"description": "Balance transfer fee amount in cents",
"hidden": false
}
},
"type": "object",
"required": [
"amount_cents"
],
"title": "BalanceTransferFeeInput",
"description": "Mandatory fee created atomically with the balance transfer draw."
},
"TransactionStatusTypeStatuses": {
"type": "string",
"enum": [
"NONE",
"PENDING",
"FAILED",
"INVALID",
"VALID",
"REVERSED",
"DECLINED",
"SETTLED",
"PARTIALLY_SETTLED",
"IN_DISPUTE",
"LENDER_WON",
"LENDER_LOST",
"POURED",
"UNPOURED",
"REPOURED",
"AUTHORIZED",
"DEFERRED"
],
"title": "TransactionStatusTypeStatuses"
}
}
}
Work with this as data
Every JSON Schema 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 schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/canopyservicing-com-create-balance-transfer-schema"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.