| DISBURSEMENT |
Funds disbursed to the business. |
| DISBURSEMENT_RETURN |
Return of previously disbursed funds. Only relevant for some AP financing setups. |
| SCHEDULED_REPAYMENT |
A repayment scheduled on the payment schedule. |
| EARLY_PAYOFF |
An early payoff of outstanding principal and interest. Early payoffs will cancel remaining scheduled repayments for installment products once they settle. |
| REFINANCE_PAYOFF |
A bookkeeping record to pay off existing principal as part of refinancing into a new loan agreement. |
| FEE |
A fee charged to the business, such as a maintenance or transaction fee. |
| REFUND |
A refund or rebate issued to the business. |
| MINIMUM_PAYMENT |
A minimum payment, relevant only for Integrated MCA products. |
example: "SCHEDULED_REPAYMENT,DISBURSEMENT"
explode: true
in: query
name: triggers
required: false
schema:
$ref: '#/components/schemas/PaymentIntentTriggerType'
style: form
- description: "When true, return only cancelled payment intents. When false,\
\ return only non-cancelled payment intents."
example: false
explode: true
in: query
name: cancelled
required: false
schema:
type: boolean
style: form
- description: The number of records to skip when performing pagination. Defaults
to `0`.
example: "0"
explode: true
in: query
name: offset
required: false
schema:
type: number
style: form
- description: "The number of records to limit when performing pagination. Defaults\
\ to `100`, which is the max."
example: "100"
explode: true
in: query
name: limit
required: false
schema:
type: number
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/GetPaymentIntentsResponse'
description: ""
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
description: BadRequestException
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
description: ForbiddenException
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
description: TooManyRequestsException
headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
explode: false
schema:
type: integer
style: simple
X-RateLimit-Remaining:
description: Number of remaining requests available.
explode: false
schema:
type: integer
style: simple
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
description: InternalServerErrorException
security:
- Authorization: []
summary: Fetch payment intents
tags:
- Payments
x-readme:
code-samples:
- language: node
install: npm install @kanmon/sdk
name: SDK
code: "\nkanmonApi.payments.getPaymentIntents({\n ...params...\n})\n \
\ "
x-accepts:
- application/json
/api/platform/v2/draw-requests/{id}:
get:
operationId: getDrawRequest
parameters:
- description: The Kanmon draw request UUID.
example: 60eaa08c-f7a5-4f3a-860d-a16dde5771d6
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/DrawRequest'
description: ""
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
description: BadRequestException
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
description: ForbiddenException
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/DrawRequestNotFoundException'
description: ""
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
description: TooManyRequestsException
headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
explode: false
schema:
type: integer
style: simple
X-RateLimit-Remaining:
description: Number of remaining requests available.
explode: false
schema:
type: integer
style: simple
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
description: InternalServerErrorException
security:
- Authorization: []
summary: Fetch a draw request
tags:
- Draw Requests
x-readme:
code-samples:
- language: node
install: npm install @kanmon/sdk
name: SDK
code: "\nkanmonApi.drawRequests.getDrawRequest({\n ...params...\n})\n \
\ "
x-accepts:
- application/json
/api/platform/v2/draw-requests:
get:
operationId: getAllDrawRequests
parameters:
- description: A comma delimited list of draw request statuses.
example: "DRAW_REQUEST_FUNDED,DRAW_REQUEST_PAID_IN_FULL"
explode: true
in: query
name: statuses
required: false
schema:
type: string
style: form
- description: A comma delimited list of Kanmon’s unique IDs for invoices.
example: "60eaa08c-f7a5-4f3a-860d-a16dde5771d6,70eaa08c-f7a5-4f3a-860d-a16dde5771e34"
explode: true
in: query
name: ids
required: false
schema:
type: string
style: form
- description: A comma delimited list of your platform’s unique IDs for businesses.
example: "12345,67890"
explode: true
in: query
name: platformBusinessIds
required: false
schema:
type: string
style: form
- description: A comma delimited list of Kanmon’s unique IDs for businesses.
example: "60eaa08c-f7a5-4f3a-860d-a16dde5771d6,70eaa08c-f7a5-4f3a-860d-a16dde5771e34"
explode: true
in: query
name: businessIds
required: false
schema:
type: string
style: form
- description: The number of records to skip when performing pagination. Defaults
to `0`.
example: "0"
explode: true
in: query
name: offset
required: false
schema:
type: number
style: form
- description: "The number of records to limit when performing pagination. Defaults\
\ to `100`, which is the max."
example: "100"
explode: true
in: query
name: limit
required: false
schema:
type: number
style: form
- description: Filter for records where `createdAt` is greater than or equal
to this value. ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
explode: true
in: query
name: createdAtStart
required: false
schema:
type: string
style: form
- description: Filter for records where `createdAt` is less than or equal to
this value. ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
explode: true
in: query
name: createdAtEnd
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/GetDrawRequestsResponse'
description: ""
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
description: BadRequestException
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
description: ForbiddenException
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
description: TooManyRequestsException
headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
explode: false
schema:
type: integer
style: simple
X-RateLimit-Remaining:
description: Number of remaining requests available.
explode: false
schema:
type: integer
style: simple
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
description: InternalServerErrorException
security:
- Authorization: []
summary: Fetch draw requests
tags:
- Draw Requests
x-readme:
code-samples:
- language: node
install: npm install @kanmon/sdk
name: SDK
code: "\nkanmonApi.drawRequests.getAllDrawRequests({\n ...params...\n})\n\
\ "
x-accepts:
- application/json
/api/platform/v2/documents:
post:
operationId: createBusinessDocument
parameters: []
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/UploadBankDocumentsRequest'
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBusinessDocumentsResponse'
description: ""
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
description: BadRequestException
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
description: ForbiddenException
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
description: TooManyRequestsException
headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
explode: false
schema:
type: integer
style: simple
X-RateLimit-Remaining:
description: Number of remaining requests available.
explode: false
schema:
type: integer
style: simple
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
description: InternalServerErrorException
security:
- Authorization: []
summary: Upload documents for a business
tags:
- Documents
x-readme:
code-samples:
- language: node
install: npm install @kanmon/sdk
name: SDK
code: "\nkanmonApi.documents.createBusinessDocument({\n ...params...\n\
})\n "
x-content-type: multipart/form-data
x-accepts:
- application/json
/api/platform/v2/integrated-mca-receivables:
get:
operationId: getReceivables
parameters:
- description: A comma delimited list of Kanmon’s unique IDs for integrated
MCA receivable.
example: "60eaa08c-f7a5-4f3a-860d-a16dde5771d6,70eaa08c-f7a5-4f3a-860d-a16dde5771e34"
explode: true
in: query
name: ids
required: false
schema:
type: string
style: form
- description: A comma delimited list of Kanmon unique IDs for issued product.
example: "60eaa08c-f7a5-4f3a-860d-a16dde5771d6,70eaa08c-f7a5-4f3a-860d-a16dde5771e34"
explode: true
in: query
name: issuedProductIds
required: false
schema:
type: string
style: form
- description: A comma delimited list of your platform’s unique IDs for transaction.
example: "12345,67890"
explode: true
in: query
name: transactionIds
required: false
schema:
type: string
style: form
- description: The number of records to skip when performing pagination. Defaults
to `0`.
example: "0"
explode: true
in: query
name: offset
required: false
schema:
type: number
style: form
- description: "The number of records to limit when performing pagination. Defaults\
\ to `100`, which is the max."
example: "100"
explode: true
in: query
name: limit
required: false
schema:
type: number
style: form
- description: Filter for records where `createdAt` is greater than or equal
to this value. ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
explode: true
in: query
name: createdAtStart
required: false
schema:
type: string
style: form
- description: Filter for records where `createdAt` is less than or equal to
this value. ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
explode: true
in: query
name: createdAtEnd
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/GetIntegratedMcaReceivablesResponse'
description: ""
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
description: BadRequestException
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
description: ForbiddenException
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
description: TooManyRequestsException
headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
explode: false
schema:
type: integer
style: simple
X-RateLimit-Remaining:
description: Number of remaining requests available.
explode: false
schema:
type: integer
style: simple
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
description: InternalServerErrorException
security:
- Authorization: []
summary: Fetch integrated MCA receivables
tags:
- Integrated MCA
x-readme:
code-samples:
- language: node
install: npm install @kanmon/sdk
name: SDK
code: "\nkanmonApi.integratedMca.getReceivables({\n ...params...\n})\n\
\ "
x-accepts:
- application/json
post:
operationId: createIntegratedMcaReceivable
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateIntegratedMcaReceivableBody'
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/IntegratedMcaReceivable'
description: ""
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/createIntegratedMcaReceivable_400_response'
description: "BadRequestException, NoRemainingBalanceException, IncorrectRepaymentAmountException"
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
description: ForbiddenException
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/IssuedProductNotFoundException'
description: IssuedProductNotFoundException
"409":
content:
application/json:
schema:
$ref: '#/components/schemas/createIntegratedMcaReceivable_409_response'
description: "IncorrectProductTypeException, IntegratedMcaReceivableAlreadyExistsException"
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
description: TooManyRequestsException
headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
explode: false
schema:
type: integer
style: simple
X-RateLimit-Remaining:
description: Number of remaining requests available.
explode: false
schema:
type: integer
style: simple
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
description: InternalServerErrorException
security:
- Authorization: []
summary: Create an integrated MCA receivable
tags:
- Integrated MCA
x-readme:
code-samples:
- language: node
install: npm install @kanmon/sdk
name: SDK
code: "\nkanmonApi.integratedMcaReceivable.createIntegratedMcaReceivable({\n\
\ ...params...\n})\n "
x-content-type: application/json
x-accepts:
- application/json
/api/platform/v2/issued-products/{id}/integrated-mca-payment-windows:
get:
operationId: getIntegratedMcaPaymentWindows
parameters:
- description: The Kanmon issued product UUID.
example: 60eaa08c-f7a5-4f3a-860d-a16dde5771d6
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/GetIntegratedMcaPaymentWindowsResponse'
description: ""
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
description: BadRequestException
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
description: ForbiddenException
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/IssuedProductNotFoundException'
description: IssuedProductNotFoundException
"409":
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessHasNoIntegratedMcaProductException'
description: BusinessHasNoIntegratedMcaProductException
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
description: TooManyRequestsException
headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
explode: false
schema:
type: integer
style: simple
X-RateLimit-Remaining:
description: Number of remaining requests available.
explode: false
schema:
type: integer
style: simple
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
description: InternalServerErrorException
security:
- Authorization: []
summary: Fetch integrated MCA payment windows for an issued product
tags:
- Integrated MCA
x-readme:
code-samples:
- language: node
install: npm install @kanmon/sdk
name: SDK
code: "\nkanmonApi.integratedMcaPaymentWindow.getIntegratedMcaPaymentWindows({\n\
\ ...params...\n})\n "
x-accepts:
- application/json
/api/platform/v2/sandbox/businesses/{id}/reset:
post:
operationId: sandboxResetBusiness
parameters:
- description: "Either the Kanmon business UUID or your platform’s business\
\ ID, depending on `idType`."
example: 60eaa08c-f7a5-4f3a-860d-a16dde5771d6
explode: false
in: path
name: id
required: true
schema: {}
style: simple
- description: Which ID type to query the business by. Defaults to `KANMON`.
Use `PLATFORM` if you want to query by your platform’s ID.
example: KANMON
explode: true
in: query
name: idType
required: false
schema:
enum:
- KANMON
- PLATFORM
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/Business'
description: ""
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
description: BadRequestException
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
description: ForbiddenException
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
description: TooManyRequestsException
headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
explode: false
schema:
type: integer
style: simple
X-RateLimit-Remaining:
description: Number of remaining requests available.
explode: false
schema:
type: integer
style: simple
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
description: InternalServerErrorException
security:
- Authorization: []
summary: Reset a business in sandbox
tags:
- Sandbox Utilities
x-readme:
code-samples:
- language: node
install: npm install @kanmon/sdk
name: SDK
code: "\nkanmonApi.businesses.sandboxResetBusiness({\n ...params...\n})\n\
\ "
x-accepts:
- application/json
/api/platform/v2/sandbox/businesses/{id}/delete:
delete:
operationId: sandboxDeleteBusiness
parameters:
- description: "Either the Kanmon business UUID or your platform’s business\
\ ID, depending on `idType`."
example: 60eaa08c-f7a5-4f3a-860d-a16dde5771d6
explode: false
in: path
name: id
required: true
schema: {}
style: simple
- description: Which ID type to query the business by. Defaults to `KANMON`.
Use `PLATFORM` if you want to query by your platform’s ID.
example: KANMON
explode: true
in: query
name: idType
required: false
schema:
enum:
- KANMON
- PLATFORM
type: string
style: form
responses:
"204":
description: ""
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
description: BadRequestException
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
description: ForbiddenException
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
description: TooManyRequestsException
headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
explode: false
schema:
type: integer
style: simple
X-RateLimit-Remaining:
description: Number of remaining requests available.
explode: false
schema:
type: integer
style: simple
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
description: InternalServerErrorException
security:
- Authorization: []
summary: Delete a business in sandbox
tags:
- Sandbox Utilities
x-readme:
code-samples:
- language: node
install: npm install @kanmon/sdk
name: SDK
code: "\nkanmonApi.businesses.sandboxDeleteBusiness({\n ...params...\n\
})\n "
x-accepts:
- application/json
/api/platform/v2/embedded-session:
post:
description: "Embedded session tokens allow you to securely pass data to Kanmon.\
\ First, you will need to call this API to create a token. Then, you will\
\ use the token when launching the embedded application."
operationId: createEmbeddedSession
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSessionTokenRequestBody'
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/EmbeddedSession'
description: Embedded session created.
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
description: BadRequestException
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
description: ForbiddenException
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessNotFoundException'
description: BusinessNotFoundException
"409":
content:
application/json:
schema:
$ref: '#/components/schemas/createEmbeddedSession_409_response'
description: "BusinessHasNoInvoiceFinancingProductException, PlatformInvoiceIdAlreadyExistsForAnotherIssuedProductException"
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
description: TooManyRequestsException
headers:
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
explode: false
schema:
type: integer
style: simple
X-RateLimit-Remaining:
description: Number of remaining requests available.
explode: false
schema:
type: integer
style: simple
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
description: InternalServerErrorException
security:
- Authorization: []
summary: Create an embedded session
tags:
- Embedded Sessions
x-readme:
code-samples:
- language: node
install: npm install @kanmon/sdk
name: SDK
code: "\nkanmonApi.embeddedSessions.createEmbeddedSession({\n ...params...\n\
})\n "
x-content-type: application/json
x-accepts:
- application/json
components:
schemas:
ProductType:
enum:
- INVOICE_FINANCING
- TERM_LOAN
- MCA
- LINE_OF_CREDIT
- INTEGRATED_MCA
- ACCOUNTS_PAYABLE_FINANCING
type: string
BusinessPrequalification:
example:
createdAt: 2022-06-01T03:57:26.115Z
product: INVOICE_FINANCING
platformBusinessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
isPrequalified: true
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
platformId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
prequalifiedAmountCents: 1000000
updatedAt: 2022-06-01T03:57:26.115Z
properties:
product:
$ref: '#/components/schemas/ProductType'
platformId:
description: The UUID representing your platform in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
businessId:
description: The UUID representing the business in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
nullable: true
type: string
platformBusinessId:
description: Your platform’s unique ID for the business.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
isPrequalified:
description: Whether or not the business has been prequalified.
type: boolean
prequalifiedAmountCents:
description: Number describing the prequalification amount of the business
in cents.
example: 1000000
nullable: true
type: number
createdAt:
description: Creation UTC ISO 8601 timestamp of the prequalification.
example: 2022-06-01T03:57:26.115Z
type: string
updatedAt:
description: Last updated UTC ISO 8601 timestamp of the prequalification.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- businessId
- createdAt
- isPrequalified
- platformBusinessId
- platformId
- prequalifiedAmountCents
- product
- updatedAt
type: object
PaginationResult:
properties:
limit:
description: The number of records to limit when performing pagination.
example: 100
type: number
offset:
description: The number of records to skip when performing pagination.
example: 0
type: number
totalCount:
description: The total number of records that matched the query.
example: 100
type: number
required:
- limit
- offset
- totalCount
type: object
GetPrequalificationsResponse:
example:
pagination: ""
prequalifications:
- createdAt: 2022-06-01T03:57:26.115Z
product: INVOICE_FINANCING
platformBusinessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
isPrequalified: true
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
platformId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
prequalifiedAmountCents: 1000000
updatedAt: 2022-06-01T03:57:26.115Z
- createdAt: 2022-06-01T03:57:26.115Z
product: INVOICE_FINANCING
platformBusinessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
isPrequalified: true
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
platformId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
prequalifiedAmountCents: 1000000
updatedAt: 2022-06-01T03:57:26.115Z
properties:
prequalifications:
description: Array of prequalifications.
items:
$ref: '#/components/schemas/BusinessPrequalification'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/PaginationResult'
description: Pagination metadata.
required:
- pagination
- prequalifications
type: object
BadRequestException:
example:
errorCode: BadRequestException
message: Bad Request
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- BadRequestException
type: string
message:
description: The human readable description of the error.
example: Bad Request
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
ForbiddenException:
example:
errorCode: ForbiddenException
message: Forbidden
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- ForbiddenException
type: string
message:
description: The human readable description of the error.
example: Forbidden
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
TooManyRequestsException:
example:
errorCode: TooManyRequestsException
message: Too Many Requests
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- TooManyRequestsException
type: string
message:
description: The human readable description of the error.
example: Too Many Requests
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
InternalServerErrorException:
example:
errorCode: InternalServerErrorException
message: Internal Server Error
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- InternalServerErrorException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
Address:
properties:
addressLineOne:
type: string
addressLineTwo:
example: Apt 123
nullable: true
type: string
city:
type: string
state:
description: The 2 character abbreviated state
enum:
- AL
- KY
- OH
- AK
- LA
- OK
- AZ
- ME
- OR
- AR
- MD
- PA
- AS
- MA
- PR
- CA
- MI
- RI
- CO
- MN
- SC
- CT
- MS
- SD
- DE
- MO
- TN
- DC
- MT
- TX
- FL
- NE
- TT
- GA
- NV
- UT
- GU
- NH
- VT
- HI
- NJ
- VA
- ID
- NM
- VI
- IL
- NY
- WA
- IN
- NC
- WV
- IA
- ND
- WI
- KS
- MP
- WY
example: CA
type: string
zipcode:
description: "Zip code can be 5 digits, 9 digits, or 5+4 including a hyphen\
\ or plus sign, e.g. 90210, 902101234, 90210-1234 or 90210+1234"
example: "94401"
type: string
country:
description: USA
example: USA
type: string
required:
- addressLineOne
- city
- country
- state
- zipcode
type: object
CreateBusinessRequestBody:
example:
website: https://www.my-business.com
metadata: "{}"
platformBusinessId: "12345"
address:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
phoneNumber: "+14155556789"
name: My Business
ein: "123456789"
isSoleProprietorship: false
customInitializationName: custom
properties:
platformBusinessId:
description: Your platform’s unique ID for the business.
example: "12345"
type: string
name:
description: The business’s name.
example: My Business
type: string
address:
allOf:
- $ref: '#/components/schemas/Address'
description: "The business’s address. The address is optional. If you provide\
\ the address, you need to provide all the required fields in the address.\
\ The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
ein:
description: "The business’s EIN. Only digits, no formatting."
example: "123456789"
type: string
phoneNumber:
description: "The business’s phone number. No formatting characters, country\
\ code is optional."
example: "+14155556789"
type: string
website:
description: The business’s website.
example: https://www.my-business.com
type: string
customInitializationName:
description: "A Custom Initialization controls custom implementation profiles\
\ for you in Kanmon. Custom Initializations enable a variety of specific\
\ configurations for your integration, including embedded UI customization,\
\ feature activation, and platform product-line identification. The Kanmon\
\ Team will work with you to establish a Custom Initialization and corresponding\
\ custom profile if your platform can benefit from this optional configuration.\
\ To identify each Custom Initialization, you can define a unique customInitializationName\
\ as a reference."
example: custom
type: string
metadata:
description: Metadata from your system that you want to associate the business
with.
type: object
isSoleProprietorship:
description: Whether the business is a sole proprietorship.
example: false
type: boolean
required:
- platformBusinessId
type: object
Business:
example:
createdAt: 2022-06-01T03:57:26.115Z
website: https://www.my-business.com
metadata: "{}"
platformBusinessId: "12345"
address:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
phoneNumber: "+14155556789"
name: My Business
id: 1193fdaf-630c-4771-a629-8da7a87947d2
ein: "123456789"
isSoleProprietorship: false
customInitializationName: custom
updatedAt: 2022-06-01T03:57:26.115Z
properties:
id:
description: The UUID representing the business in Kanmon.
example: 1193fdaf-630c-4771-a629-8da7a87947d2
type: string
platformBusinessId:
description: Your platform’s unique ID for the business.
example: "12345"
type: string
name:
description: The business’s name.
example: My Business
nullable: true
type: string
address:
allOf:
- $ref: '#/components/schemas/Address'
description: "The business’s address. The address is optional. If you provide\
\ the address, you need to provide all the required fields in the address.\
\ The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
nullable: true
ein:
description: "The business’s EIN. Only digits, no formatting."
example: "123456789"
nullable: true
type: string
phoneNumber:
description: "The business’s phone number. No formatting characters, country\
\ code is optional."
example: "+14155556789"
nullable: true
type: string
website:
description: The business’s website.
example: https://www.my-business.com
nullable: true
type: string
customInitializationName:
description: "A Custom Initialization controls custom implementation profiles\
\ for you in Kanmon. Custom Initializations enable a variety of specific\
\ configurations for your integration, including embedded UI customization,\
\ feature activation, and platform product-line identification. The Kanmon\
\ Team will work with you to establish a Custom Initialization and corresponding\
\ custom profile if your platform can benefit from this optional configuration.\
\ To identify each Custom Initialization, you can define a unique customInitializationName\
\ as a reference."
example: custom
type: string
metadata:
description: Metadata from your system that you want to associate the business
with.
type: object
isSoleProprietorship:
description: Whether the business is a sole proprietorship.
example: false
nullable: true
type: boolean
createdAt:
description: Creation UTC ISO 8601 timestamp of the business.
example: 2022-06-01T03:57:26.115Z
type: string
updatedAt:
description: Last updated UTC ISO 8601 timestamp of the business.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- createdAt
- ein
- id
- metadata
- name
- phoneNumber
- updatedAt
- website
type: object
BusinessAlreadyExistsException:
example:
errorCode: BusinessAlreadyExistsException
message: An error occurred.
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- BusinessAlreadyExistsException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
UpdateBusinessRequestBody:
example:
website: https://www.my-business.com
metadata: "{}"
platformBusinessId: "12345"
address:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
phoneNumber: "+14155556789"
name: My Business
ein: "123456789"
isSoleProprietorship: false
customInitializationName: custom
properties:
name:
description: The business’s name.
example: My Business
type: string
platformBusinessId:
description: Your platform’s unique ID for the business.
example: "12345"
type: string
address:
allOf:
- $ref: '#/components/schemas/Address'
description: "The business’s address. The address is optional. If you provide\
\ the address, you need to provide all the required fields in the address.\
\ The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
ein:
description: "The business’s EIN. Only digits, no formatting."
example: "123456789"
type: string
phoneNumber:
description: "The business’s phone number. No formatting characters, country\
\ code is optional."
example: "+14155556789"
type: string
website:
description: The business’s website.
example: https://www.my-business.com
type: string
customInitializationName:
description: "A Custom Initialization controls custom implementation profiles\
\ for you in Kanmon. Custom Initializations enable a variety of specific\
\ configurations for your integration, including embedded UI customization,\
\ feature activation, and platform product-line identification. The Kanmon\
\ Team will work with you to establish a Custom Initialization and corresponding\
\ custom profile if your platform can benefit from this optional configuration.\
\ To identify each Custom Initialization, you can define a unique customInitializationName\
\ as a reference."
example: custom
type: object
metadata:
description: Metadata from your system that you want to associate the business
with.
type: object
isSoleProprietorship:
description: Whether the business is a sole proprietorship.
example: false
type: boolean
type: object
BusinessNotFoundException:
example:
errorCode: BusinessNotFoundException
message: An error occurred.
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- BusinessNotFoundException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
ActivityLog:
example:
createdAt: 2022-06-01T03:57:26.115Z
platformBusinessId: "12345"
payload: "{}"
businessId: 1193fdaf-630c-4771-a629-8da7a87947d2
id: 1193fdaf-630c-4771-a629-8da7a87947d2
eventType: BUSINESS.NEW_ACCOUNT
updatedAt: 2022-06-01T03:57:26.115Z
properties:
id:
description: The UUID representing the activity log item in Kanmon.
example: 1193fdaf-630c-4771-a629-8da7a87947d2
type: string
businessId:
description: The UUID representing the business in Kanmon.
example: 1193fdaf-630c-4771-a629-8da7a87947d2
type: string
platformBusinessId:
description: Your platform’s unique business ID for the user.
example: "12345"
nullable: true
type: string
payload:
description: "Event details and schema: https://kanmon.dev/docs/webhook-events"
type: object
eventType:
description: A description of the log event type.
example: BUSINESS.NEW_ACCOUNT
type: string
createdAt:
description: Creation UTC ISO 8601 timestamp of the business.
example: 2022-06-01T03:57:26.115Z
type: string
updatedAt:
description: Last updated UTC ISO 8601 timestamp of the business.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- businessId
- createdAt
- eventType
- id
- payload
- platformBusinessId
- updatedAt
type: object
GetActivityLogsResponse:
example:
pagination: ""
activityLogs:
- createdAt: 2022-06-01T03:57:26.115Z
platformBusinessId: "12345"
payload: "{}"
businessId: 1193fdaf-630c-4771-a629-8da7a87947d2
id: 1193fdaf-630c-4771-a629-8da7a87947d2
eventType: BUSINESS.NEW_ACCOUNT
updatedAt: 2022-06-01T03:57:26.115Z
- createdAt: 2022-06-01T03:57:26.115Z
platformBusinessId: "12345"
payload: "{}"
businessId: 1193fdaf-630c-4771-a629-8da7a87947d2
id: 1193fdaf-630c-4771-a629-8da7a87947d2
eventType: BUSINESS.NEW_ACCOUNT
updatedAt: 2022-06-01T03:57:26.115Z
properties:
activityLogs:
description: An array of activity logs.
items:
$ref: '#/components/schemas/ActivityLog'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/PaginationResult'
description: Pagination metadata.
required:
- activityLogs
- pagination
type: object
GetBusinessesResponse:
example:
pagination: ""
businesses:
- createdAt: 2022-06-01T03:57:26.115Z
website: https://www.my-business.com
metadata: "{}"
platformBusinessId: "12345"
address:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
phoneNumber: "+14155556789"
name: My Business
id: 1193fdaf-630c-4771-a629-8da7a87947d2
ein: "123456789"
isSoleProprietorship: false
customInitializationName: custom
updatedAt: 2022-06-01T03:57:26.115Z
- createdAt: 2022-06-01T03:57:26.115Z
website: https://www.my-business.com
metadata: "{}"
platformBusinessId: "12345"
address:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
phoneNumber: "+14155556789"
name: My Business
id: 1193fdaf-630c-4771-a629-8da7a87947d2
ein: "123456789"
isSoleProprietorship: false
customInitializationName: custom
updatedAt: 2022-06-01T03:57:26.115Z
properties:
businesses:
description: Array of businesses.
items:
$ref: '#/components/schemas/Business'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/PaginationResult'
description: Pagination metadata.
required:
- businesses
- pagination
type: object
CreateUserRequestBody:
example:
firstName: John
lastName: Smith
metadata: "{}"
platformBusinessId: "12345"
phoneNumber: "+14155556789"
address:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
platformUserId: "12345"
roles:
- PRIMARY_OWNER
businessId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
isUsCitizen: true
email: user@gmail.com
properties:
platformUserId:
description: Your platform’s unique ID for the user.
example: "12345"
type: string
platformBusinessId:
description: Your platform’s unique business ID for the business. Either
`platformBusinessId` or `businessId` is required.
example: "12345"
type: string
businessId:
description: The UUID representing the user’s business in Kanmon. Either
`platformBusinessId` or `businessId` is required.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
email:
description: The user’s email.
example: user@gmail.com
type: string
firstName:
description: The user’s first name.
example: John
type: string
lastName:
description: The user’s last name.
example: Smith
type: string
phoneNumber:
description: "The user’s phone number. No formatting characters, country\
\ code is optional."
example: "+14155556789"
type: string
address:
allOf:
- $ref: '#/components/schemas/Address'
description: "The user’s address. The address is optional. If you provide\
\ the address, you need to provide all the required fields in the address.\
\ The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
roles:
description: "The user’s roles. If no roles are defined, the user will be\
\ prompted to select a role within Kanmon. \n \n | INVOICE_CREATED | \n\
\ The business has submitted an invoice and it is under review. | | \n\
\
\n \n | INVOICE_FUNDED | \n \n The\
\ funds for the invoice have been disbursed. The business is now\n \
\ expected to pay back the funds. Note that an invoice transitions to\n \
\ this state when the disbursement is initiated, not when the disbursement\n\
\ has cleared.\n | \n
\n \n | INVOICE_PAID_IN_FULL | \n\
\ A payment was made that fully paid off an outstanding invoice. | \n\
\
\n \n | INVOICE_RETURNED | \n The invoice\
\ was returned (e.g. disbursement cancelled or funds recollected from the\
\ platform). | \n
\n \n | INVOICE_PENDING_RETURN | \n\
\ The disbursement return has been initiated and we are waiting for\
\ funds to be recollected from the platform. | \n
\n \n \
\ | LATE | \n A payment was not made towards an outstanding\
\ invoice. | \n
\n \n | REJECTED | \n \
\ An invoice was rejected during the funding step. | \n
\n \n\
\ | DEFAULTED | \n A payment was not made towards an outstanding\
\ invoice and we were unable to encourage the borrower to make a payment. | \n\
\
\n
\n "
enum:
- INVOICE_CREATED
- INVOICE_FUNDED
- INVOICE_PAID_IN_FULL
- INVOICE_RETURNED
- INVOICE_PENDING_RETURN
- REJECTED
- IN_REVIEW
- DEFAULTED
- LATE
type: string
InvoiceRepaymentScheduleItem:
properties:
repaymentDate:
description: The date on which an installment of the invoice is to be repaid
- ISO 8601 format.
example: 2022-05-01
type: string
repaymentAmountCents:
description: The amount to be paid as installment - in cents.
example: 100000
type: number
repaymentFeeAmountCents:
description: The fee amount to be paid as installment - in cents.
example: 2000
type: number
repaymentPrincipalAmountCents:
description: The principal amount to be paid as installment - in cents.
example: 98000
type: number
required:
- repaymentAmountCents
- repaymentDate
- repaymentFeeAmountCents
- repaymentPrincipalAmountCents
type: object
InvoiceRepaymentSchedule:
properties:
schedule:
description: The invoice repayment schedule items.
example:
- repaymentAmountCents: 100000
repaymentDate: 2020-11-11
repaymentFeeAmountCents: 2000
repaymentPrincipalAmountCents: 98000
items:
$ref: '#/components/schemas/InvoiceRepaymentScheduleItem'
type: array
required:
- schedule
type: object
Invoice:
example:
advanceRatePercentage: 100
payeeFirstName: John
payeeType: BUSINESS
payorEmail: user@gmail.com
payorType: BUSINESS
payorMiddleName: payorMiddleName
payorLastName: Smith
payorFirstName: John
createdAt: 2022-06-01T03:57:26.115Z
amountRequestedForFinancingCents: 100000
invoiceIssuedDate: 2022-05-01
id: adbcccf9-3a7f-4040-add3-55c9d6da2d37
payeeEmail: user@gmail.com
transactionFeePercentage: 2
updatedAt: 2022-06-01T03:57:26.115Z
invoiceAdvanceAmountCents: 98000
payeeLastName: Smith
issuedProductId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
payorBusinessName: My Business
platformInvoiceId: 1234abc
invoiceDueDate: 2022-06-01
repaymentAmountCents: 100000
invoiceAmountCents: 100000
payorAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
payeeAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
principalAmountCents: 100000
platformInvoiceNumber: "123"
payeeMiddleName: payeeMiddleName
feeAmountCents: 2000
repaymentSchedule:
schedule:
- repaymentAmountCents: 100000
repaymentFeeAmountCents: 2000
repaymentPrincipalAmountCents: 98000
repaymentDate: 2020-11-11
payeeBusinessName: My Business
status: INVOICE_CREATED
properties:
id:
description: Kanmon’s unique ID for the invoice.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
platformInvoiceId:
description: Your platform’s unique ID for the invoice.
example: 1234abc
nullable: true
type: string
platformInvoiceNumber:
description: Your user-facing identifier for the invoice. This is unique
per issued product. This may or may not be the same as your `platformInvoiceId`.
example: "123"
nullable: true
type: string
invoiceAmountCents:
description: The invoice amount - in cents.
example: 100000
type: number
invoiceDueDate:
description: The date when the invoice will be paid by the payor. ISO 8601
date format.
example: 2022-06-01
nullable: true
type: string
invoiceIssuedDate:
description: The date when the payee issued the invoice. ISO 8601 date format.
example: 2022-05-01
nullable: true
type: string
payorEmail:
description: The email of the payor.
example: user@gmail.com
nullable: true
type: string
payorAddress:
allOf:
- $ref: '#/components/schemas/Address'
description: "The address of the payor. The address is optional. If you\
\ provide the address, you need to provide all the required fields in\
\ the address. The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
nullable: true
payorType:
description: '`INDIVIDUAL` if the payor is a person and `BUSINESS` if the
payor is a company.'
enum:
- BUSINESS
- INDIVIDUAL
example: BUSINESS
nullable: true
type: string
payorBusinessName:
description: The registered name of the payor business when the payor is
a business and not an individual.
example: My Business
nullable: true
type: string
payorFirstName:
description: The first name of the payor when the payor is an individual
and not a business.
example: John
nullable: true
type: string
payorMiddleName:
description: The middle name of the payor when the payor is an individual
and not a business.
nullable: true
type: string
payorLastName:
description: The last name of the payor when the payor is an individual
and not a business.
example: Smith
nullable: true
type: string
payeeEmail:
description: The email of the payee.
example: user@gmail.com
nullable: true
type: string
payeeAddress:
allOf:
- $ref: '#/components/schemas/Address'
description: "The address of the payee. The address is optional. If you\
\ provide the address, you need to provide all the required fields in\
\ the address. The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
nullable: true
payeeType:
description: '`INDIVIDUAL` if the payee is a person and `BUSINESS` if the
payee is a company.'
enum:
- BUSINESS
- INDIVIDUAL
example: BUSINESS
nullable: true
type: string
payeeBusinessName:
description: The registered name of the payee business when the payee is
a business and not an individual.
example: My Business
nullable: true
type: string
payeeFirstName:
description: The first name of the payee when the payee is an individual
and not a business.
example: John
nullable: true
type: string
payeeMiddleName:
description: The middle name of the payee when the payee is an individual
and not a business.
nullable: true
type: string
payeeLastName:
description: The last name of the payee when the payee is an individual
and not a business.
example: Smith
nullable: true
type: string
status:
$ref: '#/components/schemas/InvoiceStatus'
issuedProductId:
description: The unique identifier for the issued product within Kanmon.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
feeAmountCents:
description: The total fee amount - in cents.
example: 2000
type: number
principalAmountCents:
description: The total principal amount - in cents.
example: 100000
type: number
invoiceAdvanceAmountCents:
description: The amount after fees the business will receive - in cents.
example: 98000
type: number
repaymentAmountCents:
description: The total amount that the business will repay - in cents.
example: 100000
type: number
repaymentSchedule:
allOf:
- $ref: '#/components/schemas/InvoiceRepaymentSchedule'
description: The invoice repayment schedule.
example:
schedule:
- repaymentAmountCents: 100000
repaymentFeeAmountCents: 2000
repaymentPrincipalAmountCents: 98000
repaymentDate: 2020-11-11
advanceRatePercentage:
description: "The percentage of the invoice that is allowed for advances.\
\ E.g. a value of `80` would mean that $800 would be advanced on a $1,000\
\ invoice."
example: 100
type: number
transactionFeePercentage:
description: The percentage of the transaction that is charged as a fee.
E.g. a value of `5` means 5%.
example: 2
type: number
amountRequestedForFinancingCents:
description: The portion of the invoice amount that the business requests
to be financed - in cents.
example: 100000
type: number
createdAt:
description: Creation UTC ISO 8601 timestamp of the invoice.
example: 2022-06-01T03:57:26.115Z
type: string
updatedAt:
description: Last updated UTC ISO 8601 timestamp of the invoice.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- advanceRatePercentage
- amountRequestedForFinancingCents
- createdAt
- feeAmountCents
- id
- invoiceAdvanceAmountCents
- invoiceAmountCents
- invoiceDueDate
- invoiceIssuedDate
- issuedProductId
- payeeBusinessName
- payeeEmail
- payeeFirstName
- payeeLastName
- payeeMiddleName
- payorBusinessName
- payorEmail
- payorFirstName
- payorLastName
- payorMiddleName
- platformInvoiceId
- platformInvoiceNumber
- principalAmountCents
- repaymentAmountCents
- repaymentSchedule
- status
- transactionFeePercentage
- updatedAt
type: object
GetInvoicesResponse:
example:
pagination: ""
invoices:
- advanceRatePercentage: 100
payeeFirstName: John
payeeType: BUSINESS
payorEmail: user@gmail.com
payorType: BUSINESS
payorMiddleName: payorMiddleName
payorLastName: Smith
payorFirstName: John
createdAt: 2022-06-01T03:57:26.115Z
amountRequestedForFinancingCents: 100000
invoiceIssuedDate: 2022-05-01
id: adbcccf9-3a7f-4040-add3-55c9d6da2d37
payeeEmail: user@gmail.com
transactionFeePercentage: 2
updatedAt: 2022-06-01T03:57:26.115Z
invoiceAdvanceAmountCents: 98000
payeeLastName: Smith
issuedProductId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
payorBusinessName: My Business
platformInvoiceId: 1234abc
invoiceDueDate: 2022-06-01
repaymentAmountCents: 100000
invoiceAmountCents: 100000
payorAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
payeeAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
principalAmountCents: 100000
platformInvoiceNumber: "123"
payeeMiddleName: payeeMiddleName
feeAmountCents: 2000
repaymentSchedule:
schedule:
- repaymentAmountCents: 100000
repaymentFeeAmountCents: 2000
repaymentPrincipalAmountCents: 98000
repaymentDate: 2020-11-11
payeeBusinessName: My Business
status: INVOICE_CREATED
- advanceRatePercentage: 100
payeeFirstName: John
payeeType: BUSINESS
payorEmail: user@gmail.com
payorType: BUSINESS
payorMiddleName: payorMiddleName
payorLastName: Smith
payorFirstName: John
createdAt: 2022-06-01T03:57:26.115Z
amountRequestedForFinancingCents: 100000
invoiceIssuedDate: 2022-05-01
id: adbcccf9-3a7f-4040-add3-55c9d6da2d37
payeeEmail: user@gmail.com
transactionFeePercentage: 2
updatedAt: 2022-06-01T03:57:26.115Z
invoiceAdvanceAmountCents: 98000
payeeLastName: Smith
issuedProductId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
payorBusinessName: My Business
platformInvoiceId: 1234abc
invoiceDueDate: 2022-06-01
repaymentAmountCents: 100000
invoiceAmountCents: 100000
payorAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
payeeAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
principalAmountCents: 100000
platformInvoiceNumber: "123"
payeeMiddleName: payeeMiddleName
feeAmountCents: 2000
repaymentSchedule:
schedule:
- repaymentAmountCents: 100000
repaymentFeeAmountCents: 2000
repaymentPrincipalAmountCents: 98000
repaymentDate: 2020-11-11
payeeBusinessName: My Business
status: INVOICE_CREATED
properties:
invoices:
description: Array of invoices.
items:
$ref: '#/components/schemas/Invoice'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/PaginationResult'
description: Pagination metadata.
required:
- invoices
- pagination
type: object
FinanceInvoiceRequestBody:
example:
payeeFirstName: John
payeeLastName: Smith
payeeType: BUSINESS
issuedProductId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
payorEmail: user@gmail.com
description: Invoice for equipment purchased.
payorType: BUSINESS
payorMiddleName: payorMiddleName
payorBusinessName: My Business
payorLastName: Smith
platformInvoiceId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
invoiceDueDate: 2022-06-01
payorFirstName: John
invoiceAmountCents: 1000000
payorAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
payeeAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
amountRequestedForFinancingCents: 1000000
platformInvoiceNumber: "123"
invoiceIssuedDate: 2022-04-01
payeeMiddleName: payeeMiddleName
invoicePaymentPlanId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
payeeEmail: user@gmail.com
payeeBusinessName: My Business
properties:
issuedProductId:
description: The unique identifier for the issued product within Kanmon.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
invoicePaymentPlanId:
description: The unique identifier for the invoice payment plan within Kanmon.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
platformInvoiceId:
description: Your platform’s unique ID for the invoice.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
platformInvoiceNumber:
description: Your user-facing identifier for the invoice. This is unique
per issued product. This may or may not be the same as your `platformInvoiceId`.
example: "123"
type: string
invoiceAmountCents:
description: The invoice amount - in cents. This needs to be greater than
or equal to 100.
example: 1000000
type: number
amountRequestedForFinancingCents:
description: The amount requested for financing - in cents. The portion
of the invoice amount that the business requests to be financed. Must
be less than or equal to the `invoiceAmountCents`. This needs to be greater
than or equal to 100.
example: 1000000
type: number
invoiceDueDate:
description: "The date when the invoice will be paid. ISO 8601 date format.\
\ If `invoiceIssuedDate` is provided, then it must be after `invoiceIssuedDate`.\
\ If product type is `ACCOUNTS_PAYABLE_FINANCING`, this date must be no\
\ more than 5 days in the past. If product type is `INVOICE_FINANCING`,\
\ this date must be at least 7 days in the future."
example: 2022-06-01
type: string
invoiceIssuedDate:
description: The date when the payee issued the invoice. This is required
if product type is `INVOICE_FINANCING`. ISO 8601 date format.
example: 2022-04-01
type: string
description:
description: The description of the goods or services in the invoice.
example: Invoice for equipment purchased.
type: string
payorType:
description: '`INDIVIDUAL` if the payor is a person and `BUSINESS` if the
payor is a company. This is required if product type is `INVOICE_FINANCING`.'
enum:
- BUSINESS
- INDIVIDUAL
example: BUSINESS
type: string
payorEmail:
description: The email of the payor.
example: user@gmail.com
type: string
payorAddress:
allOf:
- $ref: '#/components/schemas/Address'
description: "The address of the payor. The address is optional. If you\
\ provide the address, you need to provide all the required fields in\
\ the address. The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
nullable: true
payorBusinessName:
description: The registered name of the payor business when the payor is
a business and not an individual. Required and should only be defined
if `payorType` is `BUSINESS`.
example: My Business
type: string
payorFirstName:
description: The first name of the payor when the payor is an individual
and not a business. Required and should only be defined if `payorType`
is `INDIVIDUAL`.
example: John
type: string
payorMiddleName:
description: The middle name of the payor when the payor is an individual
and not a business. Optional and should only be defined if `payorType`
is `INDIVIDUAL`.
type: string
payorLastName:
description: The last name of the payor when the payor is an individual
and not a business. Required and should only be defined if `payorType`
is `INDIVIDUAL`.
example: Smith
type: string
payeeType:
description: '`INDIVIDUAL` if the payee is a person and `BUSINESS` if the
payee is a company. This is required if product type is `ACCOUNTS_PAYABLE_FINANCING`.'
enum:
- BUSINESS
- INDIVIDUAL
example: BUSINESS
type: string
payeeEmail:
description: The email of the payee.
example: user@gmail.com
type: string
payeeAddress:
allOf:
- $ref: '#/components/schemas/Address'
description: "The address of the payee. The address is optional. If you\
\ provide the address, you need to provide all the required fields in\
\ the address. The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
payeeBusinessName:
description: The registered name of the payee business when the payee is
a business and not an individual. Required and should only be defined
if `payeeType` is `BUSINESS`.
example: My Business
type: string
payeeFirstName:
description: The first name of the payee when the payee is an individual
and not a business. Required and should only be defined if `payeeType`
is `INDIVIDUAL`.
example: John
type: string
payeeMiddleName:
description: The middle name of the payee when the payee is an individual
and not a business. Optional and should only be defined if `payeeType`
is `INDIVIDUAL`.
type: string
payeeLastName:
description: The last name of the payee when the payee is an individual
and not a business. Required and should only be defined if `payeeType`
is `INDIVIDUAL`.
example: Smith
type: string
required:
- amountRequestedForFinancingCents
- description
- invoiceAmountCents
- invoiceDueDate
- invoicePaymentPlanId
- issuedProductId
- platformInvoiceId
- platformInvoiceNumber
type: object
TermLoanOfferTerms:
example:
maxLoanAmountCents: 1000000
loanAmountCents: 1000000
durationMonths: 6
feePercentage: 3
interestRatePercentage: 10
productType: INVOICE_FINANCING
properties:
productType:
$ref: '#/components/schemas/ProductType'
maxLoanAmountCents:
description: The maximum loan amount - in cents.
example: 1000000
type: number
loanAmountCents:
description: "The loan amount - in cents. This defaults to `maxLoanAmountCents`.\
\ However, the business can select a smaller amount."
example: 1000000
type: number
interestRatePercentage:
description: The rate of interest on the loan. E.g. a value of `10` means
10%.
example: 10
type: number
durationMonths:
description: The duration of the loan - in months.
example: 6
type: number
feePercentage:
description: The fee percentage on the loan. E.g. a value of `3` means 3%.
example: 3
type: number
required:
- durationMonths
- feePercentage
- interestRatePercentage
- loanAmountCents
- maxLoanAmountCents
- productType
type: object
FixedDateInvoiceRepaymentWindow:
properties:
repaymentType:
enum:
- FIXED_DATE
type: string
monthlyRepaymentDay:
description: The day on which the repayment is due. E.g. a value of `15`
means the repayment is due on the 15th.
example: 15
type: number
required:
- monthlyRepaymentDay
- repaymentType
type: object
FixedDurationInvoiceRepaymentWindow:
properties:
repaymentType:
enum:
- FIXED_DURATION
type: string
repaymentDurationDays:
description: This amount of days after which the repayment duration is due.
example: 30
type: number
required:
- repaymentDurationDays
- repaymentType
type: object
PaymentPlanRepaymentScheduleItem:
properties:
repaymentDurationDays:
description: This amount of days after which the repayment duration is due.
example: 30
type: number
repaymentPercentage:
description: The percentage of the payment that is due for this repayment.
E.g. a value of `50` means 50%.
example: 50
type: number
required:
- repaymentDurationDays
- repaymentPercentage
type: object
PaymentPlanRepaymentSchedule:
properties:
schedule:
description: An array of repayment schedule items that represents how the
invoice will be paid back over multiple repayments.
items:
$ref: '#/components/schemas/PaymentPlanRepaymentScheduleItem'
type: array
required:
- schedule
type: object
MultipleDurationInvoiceRepaymentWindow:
properties:
repaymentType:
enum:
- MULTIPLE_DURATION
type: string
repaymentSchedule:
$ref: '#/components/schemas/PaymentPlanRepaymentSchedule'
required:
- repaymentSchedule
- repaymentType
type: object
InvoicePaymentPlan:
properties:
id:
description: The UUID representing the invoice payment plan.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
advanceRatePercentage:
description: "The percentage of the invoice that is allowed for advances.\
\ E.g. a value of `80` would mean that $800 would be advanced on a $1,000\
\ invoice."
example: 80
type: number
transactionFeePercentage:
description: The percentage of the transaction that is charged as a fee.
E.g. a value of `5` means 5%.
example: 5
type: number
repaymentWindow:
$ref: '#/components/schemas/InvoicePaymentPlan_repaymentWindow'
required:
- advanceRatePercentage
- id
- repaymentWindow
- transactionFeePercentage
type: object
InvoiceFinancingOfferTerms:
properties:
productType:
$ref: '#/components/schemas/ProductType'
totalLimitCents:
description: The total limit allowed for this offer - in cents.
example: 1000000
type: number
pricingPlans:
description: The pricing plans available for this offer.
items:
$ref: '#/components/schemas/InvoicePaymentPlan'
type: array
required:
- pricingPlans
- productType
- totalLimitCents
type: object
McaOfferTerms:
properties:
productType:
$ref: '#/components/schemas/ProductType'
advanceAmountCents:
description: The loan amount - in cents.
example: 1000000
type: number
repaymentPercentage:
description: "The repayment percentage for calculating repayment amounts.\
\ E.g. a value of a `20` means 20%. If a business has $100 of income over\
\ a repayment period, the repayment amount would be $20."
example: 20
type: number
feeFactor:
description: The fee percentage charged as the borrowing cost of the loan.
E.g. a value of `1.3` means a 30% fee.
example: 1.3
type: number
repaymentFrequency:
description: "The repayment frequency of the loan. E.g. biweekly repayment\
\ occurs every 14 days, weekly repayment occurs every 7 days, etc."
enum:
- DAILY
- WEEKLY
- BIWEEKLY
- MONTHLY
example: WEEKLY
type: string
totalRepaymentCents:
description: "The total repayment amount in cents required to settle and\
\ close the debt. E.g. for a $10,000 loan with a fee factor of 1.3, the\
\ repayment amount equates to $13,000."
example: 1300000
type: number
maxAdvanceAmountCents:
description: The maximum loan amount - in cents.
example: 1000000
type: number
feeAmountCents:
description: The calculated fee amount in cents.
example: 300000
type: number
required:
- advanceAmountCents
- feeAmountCents
- feeFactor
- maxAdvanceAmountCents
- productType
- repaymentFrequency
- repaymentPercentage
- totalRepaymentCents
type: object
RepaymentCadence:
enum:
- WEEKLY
- MONTHLY
type: string
LineOfCreditOfferTerms:
properties:
productType:
$ref: '#/components/schemas/ProductType'
totalLimitCents:
description: The total limit allowed for this offer - in cents.
example: 1000000
type: number
interestRatePercentage:
description: The rate of interest on the loan. E.g. a value of `10` means
10%.
example: 10
type: number
feePercentage:
description: The fee percentage charged as the borrowing cost of the loan.
E.g. a value of `2` means a 2% fee.
example: 2
type: number
repaymentDurationMonths:
deprecated: true
description: "The duration of the repayment for each draw - in months. Deprecated:\
\ use `numPaymentPeriods` and `repaymentCadence` instead."
example: 3
type: number
repaymentCadence:
$ref: '#/components/schemas/RepaymentCadence'
gracePeriodDays:
description: The number of days after each draw during which no installment
payments are due. Interest still accrues.
example: 30
type: number
numPaymentPeriods:
description: The number of installment payment periods for each draw.
example: 3
type: number
required:
- feePercentage
- gracePeriodDays
- interestRatePercentage
- numPaymentPeriods
- productType
- repaymentCadence
- repaymentDurationMonths
- totalLimitCents
type: object
IntegratedMcaOfferTerms:
properties:
productType:
$ref: '#/components/schemas/ProductType'
advanceAmountCents:
description: The loan amount - in cents.
example: 1000000
type: number
repaymentPercentage:
description: "The repayment percentage for calculating repayment amounts.\
\ E.g. a value of a `20` means 20%. If a business has $100 of income over\
\ a repayment period, the repayment amount would be $20."
example: 20
type: number
feeFactor:
description: The fee percentage charged as the borrowing cost of the loan.
E.g. a value of `1.3` means a 30% fee.
example: 1.3
type: number
totalRepaymentCents:
description: "The total repayment amount in cents required to settle and\
\ close the debt. E.g. for a $10,000 loan with a fee factor of 1.3, the\
\ repayment amount equates to $13,000."
example: 1300000
type: number
maxAdvanceAmountCents:
description: The maximum loan amount - in cents.
example: 1000000
type: number
monthlyMinimumPaymentAmountCents:
description: The monthly minimum payment amount - in cents. `null` if there
is no monthly minimum payment.
example: 100000
nullable: true
type: number
feeAmountCents:
description: The calculated fee amount in cents.
example: 300000
type: number
required:
- advanceAmountCents
- feeAmountCents
- feeFactor
- maxAdvanceAmountCents
- monthlyMinimumPaymentAmountCents
- productType
- repaymentPercentage
- totalRepaymentCents
type: object
Offer:
example:
expiredAt: 2023-12-29T03:57:26.115Z
createdAt: 2023-12-15T03:57:26.115Z
platformBusinessId: "12345"
terms:
maxLoanAmountCents: 1000000
loanAmountCents: 1000000
durationMonths: 6
feePercentage: 3
interestRatePercentage: 10
productType: INVOICE_FINANCING
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
selectedAt: 2023-12-15T03:57:26.115Z
updatedAt: 2023-12-15T03:57:26.115Z
properties:
id:
description: A unique id representing the offer object.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
businessId:
description: The UUID representing the business in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
platformBusinessId:
description: Your platform’s unique ID for the business.
example: "12345"
nullable: true
type: string
terms:
$ref: '#/components/schemas/Offer_terms'
expiredAt:
description: The ISO 8601 timestamp for when the offer expires.
example: 2023-12-29T03:57:26.115Z
nullable: true
type: string
selectedAt:
description: "If the offer has been selected by the business, the ISO 8601\
\ timestamp for when it was selected."
example: 2023-12-15T03:57:26.115Z
nullable: true
type: string
createdAt:
description: Creation ISO 8601 timestamp of the offer.
example: 2023-12-15T03:57:26.115Z
type: string
updatedAt:
description: Last updated ISO 8601 timestamp of the offer.
example: 2023-12-15T03:57:26.115Z
type: string
required:
- businessId
- createdAt
- expiredAt
- id
- platformBusinessId
- selectedAt
- terms
- updatedAt
type: object
OfferNotFoundException:
example:
errorCode: OfferNotFoundException
message: Internal Server Error
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- OfferNotFoundException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
GetOffersResponse:
example:
offers:
- expiredAt: 2023-12-29T03:57:26.115Z
createdAt: 2023-12-15T03:57:26.115Z
platformBusinessId: "12345"
terms:
maxLoanAmountCents: 1000000
loanAmountCents: 1000000
durationMonths: 6
feePercentage: 3
interestRatePercentage: 10
productType: INVOICE_FINANCING
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
selectedAt: 2023-12-15T03:57:26.115Z
updatedAt: 2023-12-15T03:57:26.115Z
- expiredAt: 2023-12-29T03:57:26.115Z
createdAt: 2023-12-15T03:57:26.115Z
platformBusinessId: "12345"
terms:
maxLoanAmountCents: 1000000
loanAmountCents: 1000000
durationMonths: 6
feePercentage: 3
interestRatePercentage: 10
productType: INVOICE_FINANCING
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
selectedAt: 2023-12-15T03:57:26.115Z
updatedAt: 2023-12-15T03:57:26.115Z
pagination: ""
properties:
offers:
description: Array of offers.
items:
$ref: '#/components/schemas/Offer'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/PaginationResult'
description: Pagination metadata.
required:
- offers
- pagination
type: object
TermLoanServicingData:
example:
interestRate: 10
loanAmountCents: 1000000
monthlyPaymentCents: 100000
nextPaymentDate: 2023-12-15
originationFeeCents: 100000
productType: INVOICE_FINANCING
principalBalanceCents: 1000000
properties:
productType:
$ref: '#/components/schemas/ProductType'
loanAmountCents:
description: The total loan amount - in cents.
example: 1000000
type: number
originationFeeCents:
description: The total origination fee amount - in cents.
example: 100000
type: number
principalBalanceCents:
description: The principal remaining on the loan - in cents.
example: 1000000
type: number
monthlyPaymentCents:
description: The monthly payment amount - in cents.
example: 100000
type: number
interestRate:
description: The interest rate of the loan. E.g. a value of `10` means 10%.
example: 10
type: number
nextPaymentDate:
description: The next scheduled payment date - ISO 8601 date format.
example: 2023-12-15
nullable: true
type: string
required:
- interestRate
- loanAmountCents
- monthlyPaymentCents
- nextPaymentDate
- originationFeeCents
- principalBalanceCents
- productType
type: object
InvoiceFinancingServicingData:
properties:
productType:
$ref: '#/components/schemas/ProductType'
totalLimitCents:
description: The total limit allowed - in cents.
type: number
pricingPlans:
description: The pricing plans available for this issued product.
items:
$ref: '#/components/schemas/InvoicePaymentPlan'
type: array
availableLimitCents:
description: The total limit less the amount of balance outstanding - in
cents.
type: number
required:
- availableLimitCents
- pricingPlans
- productType
- totalLimitCents
type: object
McaServicingData:
properties:
productType:
$ref: '#/components/schemas/ProductType'
advanceAmountCents:
description: The loan amount - in cents.
example: 1000000
type: number
repaymentPercentage:
description: "The repayment percentage for calculating repayment amounts.\
\ E.g. a value of a `20` means 20%. If a business has $100 of income over\
\ a repayment period, the repayment amount would be $20."
example: 20
type: number
feeFactor:
description: The fee percentage charged as the borrowing cost of the loan.
E.g. a value of `1.3` means a 30% fee.
example: 1.3
type: number
totalRepaymentCents:
description: "The total repayment amount in cents required to settle and\
\ close the debt. E.g. for a $10,000 loan with a fee factor of 1.3, the\
\ repayment amount equates to $13,000."
example: 1300000
type: number
repaymentFrequency:
description: "The repayment frequency of the loan. E.g. biweekly repayment\
\ occurs every 14 days, weekly repayment occurs every 7 days, etc."
enum:
- DAILY
- WEEKLY
- BIWEEKLY
- MONTHLY
example: WEEKLY
type: string
nextPaymentDate:
description: The next scheduled payment date - ISO 8601 date format.
example: 2023-12-15
nullable: true
type: string
advanceBalanceCents:
description: The total repayment amount less the amount repaid - in cents.
example: 1100000
type: number
feeAmountCents:
description: The calculated fee amount in cents.
example: 300000
type: number
required:
- advanceAmountCents
- advanceBalanceCents
- feeAmountCents
- feeFactor
- nextPaymentDate
- productType
- repaymentFrequency
- repaymentPercentage
- totalRepaymentCents
type: object
IntegratedMcaServicingData:
properties:
productType:
$ref: '#/components/schemas/ProductType'
advanceAmountCents:
description: The loan amount - in cents.
example: 1000000
type: number
repaymentPercentage:
description: "The repayment percentage for calculating repayment amounts.\
\ E.g. a value of a `20` means 20%. If a business has $100 of income over\
\ a repayment period, the repayment amount would be $20."
example: 20
type: number
feeFactor:
description: The fee percentage charged as the borrowing cost of the loan.
E.g. a value of `1.3` means a 30% fee.
example: 1.3
type: number
totalRepaymentCents:
description: "The total repayment amount in cents required to settle and\
\ close the debt. E.g. for a $10,000 loan with a fee factor of 1.3, the\
\ repayment amount equates to $13,000."
example: 1300000
type: number
advanceBalanceCents:
description: The total repayment amount less the amount repaid - in cents.
example: 1100000
type: number
monthlyMinimumPaymentAmountCents:
description: The monthly minimum payment amount - in cents. `null` if there
is no monthly minimum payment.
example: 100000
nullable: true
type: object
feeAmountCents:
description: The calculated fee amount in cents.
example: 300000
type: number
required:
- advanceAmountCents
- advanceBalanceCents
- feeAmountCents
- feeFactor
- monthlyMinimumPaymentAmountCents
- productType
- repaymentPercentage
- totalRepaymentCents
type: object
LineOfCreditServicingData:
properties:
productType:
$ref: '#/components/schemas/ProductType'
totalLimitCents:
description: The total credit limit - in cents.
example: 1000000
type: number
availableLimitCents:
description: The total limit less the amount of balance outstanding - in
cents.
example: 900000
type: number
interestRatePercentage:
description: The rate of interest on the loan. E.g. a value of `10` means
10%.
example: 10
type: number
feePercentage:
description: The fee percentage charged as the borrowing cost of the loan.
E.g. a value of `2` means a 2% fee.
example: 2
type: number
repaymentDurationMonths:
deprecated: true
description: "The duration of the repayment for each draw - in months. Deprecated:\
\ use `numPaymentPeriods` and `repaymentCadence` instead."
example: 3
type: number
repaymentCadence:
$ref: '#/components/schemas/RepaymentCadence'
gracePeriodDays:
description: The number of days after each draw during which no installment
payments are due. Interest still accrues.
example: 30
type: number
numPaymentPeriods:
description: The number of installment payment periods for each draw.
example: 3
type: number
required:
- availableLimitCents
- feePercentage
- gracePeriodDays
- interestRatePercentage
- numPaymentPeriods
- productType
- repaymentCadence
- repaymentDurationMonths
- totalLimitCents
type: object
LoanStatus:
description: |-
The current status of the loan.
| CURRENT |
All scheduled loan payments are up to date |
| LATE |
One or more scheduled loan payments are past due |
| FULLY_PAID |
The loan has been fully repaid and closed. Not applicable for AR, AP, or Line of Credit products |
| REFINANCED |
The loan has been refinanced and replaced by a new loan agreement. Not applicable for AR, AP, or Line of Credit products |
| CLOSED |
The loan has been closed and is no longer active |
| DEFAULTED |
The loan has been marked as defaulted due to missed payments |
enum:
- CURRENT
- LATE
- FULLY_PAID
- REFINANCED
- CLOSED
- DEFAULTED
type: string
IssuedProduct:
example:
createdAt: 2022-06-01T03:57:26.115Z
platformBusinessId: "12345"
servicingData:
interestRate: 10
loanAmountCents: 1000000
monthlyPaymentCents: 100000
nextPaymentDate: 2023-12-15
originationFeeCents: 100000
productType: INVOICE_FINANCING
principalBalanceCents: 1000000
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
loanStatus: CURRENT
offerId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
updatedAt: 2022-06-01T03:57:26.115Z
properties:
id:
description: The UUID representing the issued product in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
offerId:
description: The UUID representing the offer tied to this issued product
in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
businessId:
description: The UUID representing the business in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
platformBusinessId:
description: Your platform’s unique ID for the business.
example: "12345"
nullable: true
type: string
loanStatus:
$ref: '#/components/schemas/LoanStatus'
servicingData:
$ref: '#/components/schemas/IssuedProduct_servicingData'
createdAt:
description: Creation UTC ISO 8601 timestamp of the prequalification.
example: 2022-06-01T03:57:26.115Z
type: string
updatedAt:
description: Last updated UTC ISO 8601 timestamp of the prequalification.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- businessId
- createdAt
- id
- loanStatus
- offerId
- platformBusinessId
- servicingData
- updatedAt
type: object
IssuedProductNotFoundException:
example:
errorCode: IssuedProductNotFoundException
message: Internal Server Error
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- IssuedProductNotFoundException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
GetIssuedProductsResponse:
example:
pagination: ""
issuedProducts:
- createdAt: 2022-06-01T03:57:26.115Z
platformBusinessId: "12345"
servicingData:
interestRate: 10
loanAmountCents: 1000000
monthlyPaymentCents: 100000
nextPaymentDate: 2023-12-15
originationFeeCents: 100000
productType: INVOICE_FINANCING
principalBalanceCents: 1000000
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
loanStatus: CURRENT
offerId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
updatedAt: 2022-06-01T03:57:26.115Z
- createdAt: 2022-06-01T03:57:26.115Z
platformBusinessId: "12345"
servicingData:
interestRate: 10
loanAmountCents: 1000000
monthlyPaymentCents: 100000
nextPaymentDate: 2023-12-15
originationFeeCents: 100000
productType: INVOICE_FINANCING
principalBalanceCents: 1000000
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
loanStatus: CURRENT
offerId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
updatedAt: 2022-06-01T03:57:26.115Z
properties:
issuedProducts:
description: Array of issued products.
items:
$ref: '#/components/schemas/IssuedProduct'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/PaginationResult'
description: Pagination metadata.
required:
- issuedProducts
- pagination
type: object
CreateBusinessBankAccountRequestBody:
example:
routingNumber: "123456789"
platformBusinessId: "12345"
accountName: My bank account
accountType: CHECKING
roles:
- DISBURSEMENT
businessId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
accountNumber: "123456789"
platformBankAccountId: "12345"
properties:
platformBusinessId:
description: Your platform’s unique business ID for the business. Either
`platformBusinessId` or `businessId` is required.
example: "12345"
type: string
businessId:
description: The UUID representing the user’s business in Kanmon. Either
`platformBusinessId` or `businessId` is required.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
platformBankAccountId:
description: Your platform’s unique ID for the bank account.
example: "12345"
type: string
accountName:
description: The business defined bank account name.
example: My bank account
type: string
accountNumber:
description: "The business’s bank account number. Only digits, no formatting."
example: "123456789"
type: string
routingNumber:
description: "The business’s bank routing number. Should be a 9 digits number,\
\ no formatting."
example: "123456789"
type: string
accountType:
description: "The bank account’s type. Currently, we only support checking\
\ accounts. We may support others in the future."
enum:
- CHECKING
example: CHECKING
type: string
roles:
description: "The bank account’s roles. Currently, we only support creating\
\ disbursement bank account. We may support others in the future."
example:
- DISBURSEMENT
items:
enum:
- DISBURSEMENT
type: string
type: array
required:
- accountName
- accountNumber
- accountType
- platformBankAccountId
- roles
- routingNumber
type: object
BusinessBankAccount:
example:
routingNumber: "123456789"
createdAt: 2022-06-01T03:57:26.115Z
accountName: My bank account
accountType: CHECKING
roles:
- DISBURSEMENT
id: 1193fdaf-630c-4771-a629-8da7a87947d2
accountNumber: "123456789"
platformBankAccountId: "12345"
updatedAt: 2022-06-01T03:57:26.115Z
properties:
id:
description: The UUID representing the business bank account in Kanmon.
example: 1193fdaf-630c-4771-a629-8da7a87947d2
type: string
platformBankAccountId:
description: Your platform’s unique ID for the bank account.
example: "12345"
type: string
accountName:
description: The business bank account’s name.
example: My bank account
nullable: true
type: string
accountNumber:
description: "The business’s bank account number. Only digits, no formatting."
example: "123456789"
type: string
routingNumber:
description: "The business’s bank routing number. Only digits, no formatting."
example: "123456789"
type: string
accountType:
description: "The bank account’s type. Currently, we only support checking\
\ accounts. We may support others in the future."
enum:
- CHECKING
example: CHECKING
type: string
roles:
description: "The bank account’s roles. Currently, we only support disbursement\
\ bank role."
example:
- DISBURSEMENT
items:
enum:
- DISBURSEMENT
type: string
type: array
createdAt:
description: Creation UTC ISO 8601 timestamp of the business.
example: 2022-06-01T03:57:26.115Z
type: string
updatedAt:
description: Last updated UTC ISO 8601 timestamp of the business.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- accountName
- accountNumber
- accountType
- createdAt
- id
- platformBankAccountId
- roles
- routingNumber
- updatedAt
type: object
BankAccountAlreadyExistException:
example:
errorCode: BankAccountAlreadyExistException
message: An error occurred.
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- BankAccountAlreadyExistException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
BankAccountNotFoundException:
example:
errorCode: BankAccountNotFoundException
message: An error occurred.
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- BankAccountNotFoundException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
GetBusinessBankAccountsResponse:
example:
pagination: ""
bankAccounts:
- routingNumber: "123456789"
createdAt: 2022-06-01T03:57:26.115Z
accountName: My bank account
accountType: CHECKING
roles:
- DISBURSEMENT
id: 1193fdaf-630c-4771-a629-8da7a87947d2
accountNumber: "123456789"
platformBankAccountId: "12345"
updatedAt: 2022-06-01T03:57:26.115Z
- routingNumber: "123456789"
createdAt: 2022-06-01T03:57:26.115Z
accountName: My bank account
accountType: CHECKING
roles:
- DISBURSEMENT
id: 1193fdaf-630c-4771-a629-8da7a87947d2
accountNumber: "123456789"
platformBankAccountId: "12345"
updatedAt: 2022-06-01T03:57:26.115Z
properties:
bankAccounts:
description: Array of business bank accounts.
items:
$ref: '#/components/schemas/BusinessBankAccount'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/PaginationResult'
description: Pagination metadata.
required:
- bankAccounts
- pagination
type: object
UpdateBusinessAccountRequestBody:
example:
routingNumber: "123456789"
accountName: My account
accountNumber: "123456789"
platformBankAccountId: "12345"
properties:
platformBankAccountId:
description: Your platform’s unique ID for the bank account.
example: "12345"
type: string
accountName:
description: The business defined bank account name.
example: My account
type: string
accountNumber:
description: "The business’s bank account number. Only digits, no formatting."
example: "123456789"
type: string
routingNumber:
description: "The business’s bank routing number. Should be a 9 digits number,\
\ no formatting."
example: "123456789"
type: string
type: object
PaymentOrderStatus:
description: The status of the payment.
enum:
- FAILED
- PAID
- PENDING
type: string
PaymentOrder:
example:
drawRequestId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
platformInvoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
feeType: INSUFFICIENT_FUNDS
totalPaymentAmountCents: 100000
createdAt: 2022-06-01T03:57:26.115Z
principalPaymentAmountCents: 80000
interestPaymentAmountCents: 10000
invoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
settledDate: 2024-01-03
effectiveDate: 2024-01-01
feePaymentAmountCents: 10000
direction: DISBURSEMENT
status: FAILED
updatedAt: 2022-06-01T03:57:26.115Z
properties:
id:
description: The UUID representing the payment order in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
issuedProductId:
description: The UUID representing the issued product in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
drawRequestId:
description: The UUID representing the draw request in Kanmon. (only present
for Line of Credit).
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
nullable: true
type: string
invoiceId:
description: The UUID representing the invoice in Kanmon. (only present
for Invoice Financing).
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
nullable: true
type: string
platformInvoiceId:
description: Your platform’s unique ID for the invoice. (only present for
Invoice Financing).
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
nullable: true
type: string
effectiveDate:
description: The effective UTC ISO 8601 date that the payment will process.
example: 2024-01-01
type: string
settledDate:
description: The UTC ISO 8601 date that the payment was settled.
example: 2024-01-03
nullable: true
type: string
totalPaymentAmountCents:
description: The total payment amount - in cents.
example: 100000
type: number
principalPaymentAmountCents:
description: The principal payment amount - in cents. (null for disbursements).
example: 80000
nullable: true
type: number
interestPaymentAmountCents:
description: The interest payment amount - in cents. (null for disbursements).
example: 10000
nullable: true
type: number
feePaymentAmountCents:
description: The fee payment amount - in cents. (null for disbursements).
example: 10000
nullable: true
type: number
feeType:
description: The type of the fee that was charged. (only present when `feePaymentAmountCents`
is not 0 or null).
enum:
- LATE_PAYMENT
- INSUFFICIENT_FUNDS
- TRANSACTION_FEE
- MAINTENANCE
- EXTENSION_FEE
example: INSUFFICIENT_FUNDS
nullable: true
type: string
direction:
description: The direction of the payment.
enum:
- DISBURSEMENT
- REPAYMENT
example: DISBURSEMENT
type: string
status:
$ref: '#/components/schemas/PaymentOrderStatus'
createdAt:
description: Creation UTC ISO 8601 timestamp of the payment order.
example: 2022-06-01T03:57:26.115Z
type: string
updatedAt:
description: Last updated UTC ISO 8601 timestamp of the payment order.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- createdAt
- direction
- drawRequestId
- effectiveDate
- feePaymentAmountCents
- id
- interestPaymentAmountCents
- invoiceId
- issuedProductId
- platformInvoiceId
- principalPaymentAmountCents
- settledDate
- status
- totalPaymentAmountCents
- updatedAt
type: object
PaymentOrderNotFoundException:
example:
errorCode: PaymentOrderNotFoundException
message: Internal Server Error
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- PaymentOrderNotFoundException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
PaymentScheduleItem:
example:
totalPaymentAmountCents: 100000
paymentOrder: ""
effectiveDate: 2024-01-01
properties:
effectiveDate:
description: The effective UTC ISO 8601 date that the payment will process.
example: 2024-01-01
type: string
totalPaymentAmountCents:
description: The total payment amount - in cents.
example: 100000
type: number
paymentOrder:
allOf:
- $ref: '#/components/schemas/PaymentOrder'
description: The payment order for this schedule item
nullable: true
required:
- effectiveDate
- totalPaymentAmountCents
type: object
GetPaymentScheduleResponse:
example:
pagination: ""
paymentSchedule:
- totalPaymentAmountCents: 100000
paymentOrder: ""
effectiveDate: 2024-01-01
- totalPaymentAmountCents: 100000
paymentOrder: ""
effectiveDate: 2024-01-01
properties:
paymentSchedule:
description: Array of payment schedule items for an issued product.
items:
$ref: '#/components/schemas/PaymentScheduleItem'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/PaginationResult'
description: Pagination metadata.
required:
- pagination
- paymentSchedule
type: object
PaymentIntentTriggerType:
enum:
- DISBURSEMENT
- DISBURSEMENT_RETURN
- SCHEDULED_REPAYMENT
- EARLY_PAYOFF
- REFINANCE_PAYOFF
- FEE
- REFUND
- MINIMUM_PAYMENT
type: string
PaymentIntent:
example:
drawRequestId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
confirmedRemainingBalanceCents: 0
confirmedPrincipalAmountCents: 80000
confirmedFeeAmountCents: 10000
createdAt: 2022-06-01T03:57:26.115Z
totalAmountCents: 100000
paymentOrders:
- drawRequestId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
platformInvoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
feeType: INSUFFICIENT_FUNDS
totalPaymentAmountCents: 100000
createdAt: 2022-06-01T03:57:26.115Z
principalPaymentAmountCents: 80000
interestPaymentAmountCents: 10000
invoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
settledDate: 2024-01-03
effectiveDate: 2024-01-01
feePaymentAmountCents: 10000
direction: DISBURSEMENT
status: FAILED
updatedAt: 2022-06-01T03:57:26.115Z
- drawRequestId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
platformInvoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
feeType: INSUFFICIENT_FUNDS
totalPaymentAmountCents: 100000
createdAt: 2022-06-01T03:57:26.115Z
principalPaymentAmountCents: 80000
interestPaymentAmountCents: 10000
invoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
settledDate: 2024-01-03
effectiveDate: 2024-01-01
feePaymentAmountCents: 10000
direction: DISBURSEMENT
status: FAILED
updatedAt: 2022-06-01T03:57:26.115Z
pendingFeeAmountCents: 0
isLate: false
pendingInterestAmountCents: 0
pendingRemainingBalanceCents: 0
confirmedTotalAmountCents: 100000
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
interestAmountCents: 10000
pendingPrincipalAmountCents: 0
direction: REPAYMENT
updatedAt: 2022-06-01T03:57:26.115Z
cancelledAt: 2024-01-03T03:57:26.115Z
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
trigger: SCHEDULED_REPAYMENT
feeType: INSUFFICIENT_FUNDS
pendingTotalAmountCents: 0
principalAmountCents: 80000
confirmedInterestAmountCents: 10000
invoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
feeAmountCents: 10000
scheduledPaymentDate: 2024-01-01
properties:
id:
description: The UUID representing the payment intent in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
issuedProductId:
description: The UUID representing the issued product in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
drawRequestId:
description: The UUID representing the draw request in Kanmon. (only present
for Line of Credit).
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
nullable: true
type: string
invoiceId:
description: The UUID representing the invoice in Kanmon. (only present
for Invoice Financing).
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
nullable: true
type: string
direction:
description: The direction of the payment.
enum:
- DISBURSEMENT
- REPAYMENT
example: REPAYMENT
type: string
trigger:
description: |-
What caused this payment intent to be created.
| DISBURSEMENT |
Funds disbursed to the business. |
| DISBURSEMENT_RETURN |
Return of previously disbursed funds. Only relevant for some AP financing setups. |
| SCHEDULED_REPAYMENT |
A repayment scheduled on the payment schedule. |
| EARLY_PAYOFF |
An early payoff of outstanding principal and interest. Early payoffs will cancel remaining scheduled repayments for installment products once they settle. |
| REFINANCE_PAYOFF |
A bookkeeping record to pay off existing principal as part of refinancing into a new loan agreement. |
| FEE |
A fee charged to the business, such as a maintenance or transaction fee. |
| REFUND |
A refund or rebate issued to the business. |
| MINIMUM_PAYMENT |
A minimum payment, relevant only for Integrated MCA products. |
enum:
- DISBURSEMENT
- DISBURSEMENT_RETURN
- SCHEDULED_REPAYMENT
- EARLY_PAYOFF
- REFINANCE_PAYOFF
- FEE
- REFUND
- MINIMUM_PAYMENT
example: SCHEDULED_REPAYMENT
type: string
totalAmountCents:
description: The total intended payment amount - in cents.
example: 100000
type: number
principalAmountCents:
description: The intended principal payment amount - in cents. (null for
disbursements).
example: 80000
nullable: true
type: number
interestAmountCents:
description: The intended interest payment amount - in cents. (null for
disbursements).
example: 10000
nullable: true
type: number
feeAmountCents:
description: The intended fee payment amount - in cents. (null for disbursements).
example: 10000
nullable: true
type: number
feeType:
description: The type of the fee. (only present when `feeAmountCents` is
not 0 or null).
enum:
- LATE_PAYMENT
- INSUFFICIENT_FUNDS
- TRANSACTION_FEE
- MAINTENANCE
- EXTENSION_FEE
example: INSUFFICIENT_FUNDS
nullable: true
type: string
scheduledPaymentDate:
description: The UTC ISO 8601 date that the payment is scheduled to process.
example: 2024-01-01
type: string
isLate:
description: Whether this scheduled repayment is past due and unpaid. Only
applies to scheduled repayments that are not cancelled or fully paid.
example: false
type: boolean
confirmedPrincipalAmountCents:
description: The confirmed (settled) principal amount - in cents.
example: 80000
type: number
confirmedInterestAmountCents:
description: The confirmed (settled) interest amount - in cents.
example: 10000
type: number
confirmedFeeAmountCents:
description: The confirmed (settled) fee amount - in cents.
example: 10000
type: number
confirmedTotalAmountCents:
description: The confirmed (settled) total amount - in cents.
example: 100000
type: number
pendingPrincipalAmountCents:
description: The pending (in-flight) principal amount - in cents.
example: 0
type: number
pendingInterestAmountCents:
description: The pending (in-flight) interest amount - in cents.
example: 0
type: number
pendingFeeAmountCents:
description: The pending (in-flight) fee amount - in cents.
example: 0
type: number
pendingTotalAmountCents:
description: The pending (in-flight) total amount - in cents.
example: 0
type: number
confirmedRemainingBalanceCents:
description: The remaining balance after confirmed payments are applied
- in cents.
example: 0
type: number
pendingRemainingBalanceCents:
description: The remaining balance after confirmed and pending payments
are applied - in cents.
example: 0
type: number
cancelledAt:
description: The UTC ISO 8601 timestamp that the payment intent was cancelled.
example: 2024-01-03T03:57:26.115Z
nullable: true
type: string
createdAt:
description: Creation UTC ISO 8601 timestamp of the payment intent.
example: 2022-06-01T03:57:26.115Z
type: string
updatedAt:
description: Last updated UTC ISO 8601 timestamp of the payment intent.
example: 2022-06-01T03:57:26.115Z
type: string
paymentOrders:
description: The payment orders associated with this payment intent.
items:
$ref: '#/components/schemas/PaymentOrder'
type: array
required:
- cancelledAt
- confirmedFeeAmountCents
- confirmedInterestAmountCents
- confirmedPrincipalAmountCents
- confirmedRemainingBalanceCents
- confirmedTotalAmountCents
- createdAt
- direction
- drawRequestId
- feeAmountCents
- id
- interestAmountCents
- invoiceId
- isLate
- issuedProductId
- paymentOrders
- pendingFeeAmountCents
- pendingInterestAmountCents
- pendingPrincipalAmountCents
- pendingRemainingBalanceCents
- pendingTotalAmountCents
- principalAmountCents
- scheduledPaymentDate
- totalAmountCents
- trigger
- updatedAt
type: object
GetPaymentIntentsResponse:
example:
pagination: ""
paymentIntents:
- drawRequestId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
confirmedRemainingBalanceCents: 0
confirmedPrincipalAmountCents: 80000
confirmedFeeAmountCents: 10000
createdAt: 2022-06-01T03:57:26.115Z
totalAmountCents: 100000
paymentOrders:
- drawRequestId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
platformInvoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
feeType: INSUFFICIENT_FUNDS
totalPaymentAmountCents: 100000
createdAt: 2022-06-01T03:57:26.115Z
principalPaymentAmountCents: 80000
interestPaymentAmountCents: 10000
invoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
settledDate: 2024-01-03
effectiveDate: 2024-01-01
feePaymentAmountCents: 10000
direction: DISBURSEMENT
status: FAILED
updatedAt: 2022-06-01T03:57:26.115Z
- drawRequestId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
platformInvoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
feeType: INSUFFICIENT_FUNDS
totalPaymentAmountCents: 100000
createdAt: 2022-06-01T03:57:26.115Z
principalPaymentAmountCents: 80000
interestPaymentAmountCents: 10000
invoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
settledDate: 2024-01-03
effectiveDate: 2024-01-01
feePaymentAmountCents: 10000
direction: DISBURSEMENT
status: FAILED
updatedAt: 2022-06-01T03:57:26.115Z
pendingFeeAmountCents: 0
isLate: false
pendingInterestAmountCents: 0
pendingRemainingBalanceCents: 0
confirmedTotalAmountCents: 100000
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
interestAmountCents: 10000
pendingPrincipalAmountCents: 0
direction: REPAYMENT
updatedAt: 2022-06-01T03:57:26.115Z
cancelledAt: 2024-01-03T03:57:26.115Z
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
trigger: SCHEDULED_REPAYMENT
feeType: INSUFFICIENT_FUNDS
pendingTotalAmountCents: 0
principalAmountCents: 80000
confirmedInterestAmountCents: 10000
invoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
feeAmountCents: 10000
scheduledPaymentDate: 2024-01-01
- drawRequestId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
confirmedRemainingBalanceCents: 0
confirmedPrincipalAmountCents: 80000
confirmedFeeAmountCents: 10000
createdAt: 2022-06-01T03:57:26.115Z
totalAmountCents: 100000
paymentOrders:
- drawRequestId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
platformInvoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
feeType: INSUFFICIENT_FUNDS
totalPaymentAmountCents: 100000
createdAt: 2022-06-01T03:57:26.115Z
principalPaymentAmountCents: 80000
interestPaymentAmountCents: 10000
invoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
settledDate: 2024-01-03
effectiveDate: 2024-01-01
feePaymentAmountCents: 10000
direction: DISBURSEMENT
status: FAILED
updatedAt: 2022-06-01T03:57:26.115Z
- drawRequestId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
platformInvoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
feeType: INSUFFICIENT_FUNDS
totalPaymentAmountCents: 100000
createdAt: 2022-06-01T03:57:26.115Z
principalPaymentAmountCents: 80000
interestPaymentAmountCents: 10000
invoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
settledDate: 2024-01-03
effectiveDate: 2024-01-01
feePaymentAmountCents: 10000
direction: DISBURSEMENT
status: FAILED
updatedAt: 2022-06-01T03:57:26.115Z
pendingFeeAmountCents: 0
isLate: false
pendingInterestAmountCents: 0
pendingRemainingBalanceCents: 0
confirmedTotalAmountCents: 100000
id: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
interestAmountCents: 10000
pendingPrincipalAmountCents: 0
direction: REPAYMENT
updatedAt: 2022-06-01T03:57:26.115Z
cancelledAt: 2024-01-03T03:57:26.115Z
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
trigger: SCHEDULED_REPAYMENT
feeType: INSUFFICIENT_FUNDS
pendingTotalAmountCents: 0
principalAmountCents: 80000
confirmedInterestAmountCents: 10000
invoiceId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
feeAmountCents: 10000
scheduledPaymentDate: 2024-01-01
properties:
paymentIntents:
description: "A payment intent represents a planned payment on an issued\
\ product, such as a disbursement, scheduled repayment, fee, or refund.\
\ It tracks intended amounts, whether the payment is late, settlement\
\ progress via the confirmed and pending amount fields, and the payment\
\ orders that actually move funds. Payment intents may be cancelled when\
\ superseded — for example, by an early payoff."
items:
$ref: '#/components/schemas/PaymentIntent'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/PaginationResult'
description: Pagination metadata.
required:
- pagination
- paymentIntents
type: object
DrawRequestState:
description: The state of the draw request.
enum:
- DRAW_REQUEST_CREATED
- DRAW_REQUEST_FUNDED
- DRAW_REQUEST_PAID_IN_FULL
- REJECTED
- DEFAULTED
type: string
DrawRequest:
example:
gracePeriodDays: 30
remainingBalanceCents: 500000
feePercentage: 5
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
disbursementAmountCents: 960000
createdAt: 2022-06-01T03:57:26.115Z
amountCents: 1000000
repaymentCadence: WEEKLY
id: adbcccf9-3a7f-4040-add3-55c9d6da2d37
feeAmountCents: 40000
interestRatePercentage: 10
repaymentDurationMonths: 6
status: DRAW_REQUEST_CREATED
numPaymentPeriods: 3
updatedAt: 2022-06-01T03:57:26.115Z
properties:
id:
description: Kanmon’s unique ID for the draw request.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
issuedProductId:
description: The UUID representing the issued product in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
amountCents:
description: The total draw request amount - in cents.
example: 1000000
type: number
disbursementAmountCents:
description: "The total draw request amount, less the fees - in cents. This\
\ is the amount disbursed to the business if the draw request is approved."
example: 960000
type: number
feeAmountCents:
description: The fee amount - in cents.
example: 40000
type: number
status:
$ref: '#/components/schemas/DrawRequestState'
interestRatePercentage:
description: The interest rate for the draw request. E.g. a value of `10`
means 10%.
example: 10
type: number
feePercentage:
description: The fee percentage charged as the borrowing cost of the draw
request. E.g. a value of `2` means a 2% fee.
example: 5
type: number
repaymentDurationMonths:
deprecated: true
description: "The duration of the repayment for the draw request - in months.\
\ Deprecated: use `numPaymentPeriods` and `repaymentCadence` instead."
example: 6
type: number
repaymentCadence:
$ref: '#/components/schemas/RepaymentCadence'
gracePeriodDays:
description: The number of days after the draw during which no installment
payments are due. Interest still accrues.
example: 30
type: number
numPaymentPeriods:
description: The number of installment payment periods for the draw request.
example: 3
type: number
remainingBalanceCents:
description: The outstanding principal balance on the draw request - in
cents. Equal to the original draw amount minus confirmed principal repayments.
example: 500000
type: number
createdAt:
description: Creation UTC ISO 8601 timestamp of the draw request.
example: 2022-06-01T03:57:26.115Z
type: string
updatedAt:
description: Last updated UTC ISO 8601 timestamp of the draw request.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- amountCents
- createdAt
- disbursementAmountCents
- feeAmountCents
- feePercentage
- gracePeriodDays
- id
- interestRatePercentage
- issuedProductId
- numPaymentPeriods
- remainingBalanceCents
- repaymentCadence
- repaymentDurationMonths
- status
- updatedAt
type: object
DrawRequestNotFoundException:
example:
errorCode: DrawRequestNotFoundException
message: Internal Server Error
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- DrawRequestNotFoundException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
GetDrawRequestsResponse:
example:
drawRequests:
- gracePeriodDays: 30
remainingBalanceCents: 500000
feePercentage: 5
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
disbursementAmountCents: 960000
createdAt: 2022-06-01T03:57:26.115Z
amountCents: 1000000
repaymentCadence: WEEKLY
id: adbcccf9-3a7f-4040-add3-55c9d6da2d37
feeAmountCents: 40000
interestRatePercentage: 10
repaymentDurationMonths: 6
status: DRAW_REQUEST_CREATED
numPaymentPeriods: 3
updatedAt: 2022-06-01T03:57:26.115Z
- gracePeriodDays: 30
remainingBalanceCents: 500000
feePercentage: 5
issuedProductId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
disbursementAmountCents: 960000
createdAt: 2022-06-01T03:57:26.115Z
amountCents: 1000000
repaymentCadence: WEEKLY
id: adbcccf9-3a7f-4040-add3-55c9d6da2d37
feeAmountCents: 40000
interestRatePercentage: 10
repaymentDurationMonths: 6
status: DRAW_REQUEST_CREATED
numPaymentPeriods: 3
updatedAt: 2022-06-01T03:57:26.115Z
pagination: ""
properties:
drawRequests:
description: Array of draw requests.
items:
$ref: '#/components/schemas/DrawRequest'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/PaginationResult'
description: Pagination metadata.
required:
- drawRequests
- pagination
type: object
UploadBankDocumentsRequest:
properties:
invoices:
description: "Invoices to be uploaded. The file format must be PDF. The\
\ limit is 10 files, 10 MB per file."
items:
format: binary
type: string
type: array
businessId:
description: The unique identifier for business within Kanmon. Either of
`businessId` or `platformBusinessId` is required.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
platformBusinessId:
description: The unique identifier for business in your platform. Either
of `businessId` or `platformBusinessId` is required.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
required:
- invoices
type: object
BusinessDocumentType:
description: The type of document that is uploaded.
enum:
- INVOICE
type: string
BusinessDocument:
example:
originalFileName: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
createdAt: 2022-06-01T03:57:26.115Z
platformBusinessId: "12345"
documentType: INVOICE
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 1193fdaf-630c-4771-a629-8da7a87947d2
updatedAt: 2022-06-01T03:57:26.115Z
properties:
id:
description: The UUID representing the business document in Kanmon.
example: 1193fdaf-630c-4771-a629-8da7a87947d2
type: string
platformBusinessId:
description: Your platform’s unique ID for the business.
example: "12345"
nullable: true
type: string
businessId:
description: The UUID representing the business in Kanmon.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
documentType:
$ref: '#/components/schemas/BusinessDocumentType'
originalFileName:
description: The file’s original file name.
example: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
type: string
createdAt:
description: Creation UTC ISO 8601 timestamp of the business document.
example: 2022-06-01T03:57:26.115Z
type: string
updatedAt:
description: Last updated UTC ISO 8601 timestamp of the business document.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- businessId
- createdAt
- documentType
- id
- originalFileName
- platformBusinessId
- updatedAt
type: object
CreateBusinessDocumentsResponse:
example:
documents:
- originalFileName: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
createdAt: 2022-06-01T03:57:26.115Z
platformBusinessId: "12345"
documentType: INVOICE
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 1193fdaf-630c-4771-a629-8da7a87947d2
updatedAt: 2022-06-01T03:57:26.115Z
- originalFileName: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
createdAt: 2022-06-01T03:57:26.115Z
platformBusinessId: "12345"
documentType: INVOICE
businessId: 2b5d0f14-9b73-4f44-a82a-2182a9ff77bb
id: 1193fdaf-630c-4771-a629-8da7a87947d2
updatedAt: 2022-06-01T03:57:26.115Z
properties:
documents:
description: The documents that were uploaded.
items:
$ref: '#/components/schemas/BusinessDocument'
type: array
required:
- documents
type: object
IntegratedMcaReceivable:
example:
createdAt: 2022-06-01T03:57:26.115Z
issuedProductId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
id: adbcccf9-3a7f-4040-add3-55c9d6da2d37
chargeAmountCents: 1000000
transactionTime: 2022-06-01T03:57:26.115Z
transactionId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
repaymentAmountCents: 100000
updatedAt: 2022-06-01T03:57:26.115Z
properties:
id:
description: Kanmon’s unique ID for the integrated MCA receivable.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
issuedProductId:
description: The unique identifier for the issued product within Kanmon.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
chargeAmountCents:
description: The charge amount - in cents.
example: 1000000
type: number
repaymentAmountCents:
description: The repayment amount - in cents. It should be the minimum between
(repayment percentage * charge amount) or remaining balance.
example: 100000
type: number
transactionId:
description: Your platform’s unique ID for the transaction.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
transactionTime:
description: Creation UTC ISO 8601 timestamp of the transaction.
example: 2022-06-01T03:57:26.115Z
type: string
createdAt:
description: Creation UTC ISO 8601 timestamp of the receivable.
example: 2022-06-01T03:57:26.115Z
type: string
updatedAt:
description: Last updated UTC ISO 8601 timestamp of the receivable.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- chargeAmountCents
- createdAt
- id
- issuedProductId
- repaymentAmountCents
- transactionId
- transactionTime
- updatedAt
type: object
GetIntegratedMcaReceivablesResponse:
example:
pagination: ""
integratedMcaReceivables:
- createdAt: 2022-06-01T03:57:26.115Z
issuedProductId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
id: adbcccf9-3a7f-4040-add3-55c9d6da2d37
chargeAmountCents: 1000000
transactionTime: 2022-06-01T03:57:26.115Z
transactionId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
repaymentAmountCents: 100000
updatedAt: 2022-06-01T03:57:26.115Z
- createdAt: 2022-06-01T03:57:26.115Z
issuedProductId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
id: adbcccf9-3a7f-4040-add3-55c9d6da2d37
chargeAmountCents: 1000000
transactionTime: 2022-06-01T03:57:26.115Z
transactionId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
repaymentAmountCents: 100000
updatedAt: 2022-06-01T03:57:26.115Z
properties:
integratedMcaReceivables:
description: The integrated MCA receivables that were created.
items:
$ref: '#/components/schemas/IntegratedMcaReceivable'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/PaginationResult'
description: Pagination metadata.
required:
- integratedMcaReceivables
- pagination
type: object
CreateIntegratedMcaReceivableBody:
example:
issuedProductId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
chargeAmountCents: 1000000
transactionTime: 2022-06-01T03:57:26.115Z
transactionId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
repaymentAmountCents: 100000
properties:
issuedProductId:
description: The unique identifier for the issued product within Kanmon.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
chargeAmountCents:
description: The charge amount - in cents.
example: 1000000
type: number
repaymentAmountCents:
description: |2
The repayment amount - in cents. It should be the lesser of:
( repayment percentage × charge amount ) or remaining balance
example: 100000
type: number
transactionId:
description: Your platform’s unique ID for the transaction.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
transactionTime:
description: Creation UTC ISO 8601 timestamp of the transaction.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- chargeAmountCents
- issuedProductId
- repaymentAmountCents
- transactionId
- transactionTime
type: object
IntegratedMcaPaymentWindow:
example:
windowStartDate: 2022-06-01T03:57:26.115Z
totalRepaymentAmountCentsInWindow: 1000000
minimumPaymentAmountCentsInWindow: 100000
windowEndDate: 2022-07-01T03:57:26.115Z
properties:
windowStartDate:
description: Start UTC ISO 8601 timestamp of the payment window.
example: 2022-06-01T03:57:26.115Z
type: string
windowEndDate:
description: End UTC ISO 8601 timestamp of the payment window.
example: 2022-07-01T03:57:26.115Z
type: string
totalRepaymentAmountCentsInWindow:
description: Total repayment amount during this window - in cents.
example: 1000000
type: number
minimumPaymentAmountCentsInWindow:
description: Minimum payment amount for this window - in cents. This is
`null` if no minimum payment was collected.
example: 100000
nullable: true
type: object
required:
- minimumPaymentAmountCentsInWindow
- totalRepaymentAmountCentsInWindow
- windowEndDate
- windowStartDate
type: object
GetIntegratedMcaPaymentWindowsResponse:
example:
paymentWindows:
- windowStartDate: 2022-06-01T03:57:26.115Z
totalRepaymentAmountCentsInWindow: 1000000
minimumPaymentAmountCentsInWindow: 100000
windowEndDate: 2022-07-01T03:57:26.115Z
- windowStartDate: 2022-06-01T03:57:26.115Z
totalRepaymentAmountCentsInWindow: 1000000
minimumPaymentAmountCentsInWindow: 100000
windowEndDate: 2022-07-01T03:57:26.115Z
properties:
paymentWindows:
description: The payment periods for the integrated MCA.
items:
$ref: '#/components/schemas/IntegratedMcaPaymentWindow'
type: array
required:
- paymentWindows
type: object
BusinessHasNoIntegratedMcaProductException:
example:
errorCode: BusinessHasNoIntegratedMcaProductException
message: An error occurred.
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- BusinessHasNoIntegratedMcaProductException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
SessionInvoice:
example:
payorEmail: user@gmail.com
payorType: BUSINESS
description: Invoice for equipment purchased.
payorMiddleName: payorMiddleName
payorBusinessName: My Business
payorLastName: Smith
platformInvoiceId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
invoiceDueDate: 2022-06-01
payorFirstName: John
invoiceAmountCents: 1000000
payorAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
platformInvoiceNumber: "123"
invoiceIssuedDate: 2022-04-01
properties:
platformInvoiceId:
description: Your platform’s unique ID for the invoice.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
platformInvoiceNumber:
description: Your user-facing identifier for the invoice. This is unique
per issued product. This may or may not be the same as your `platformInvoiceId`.
example: "123"
type: string
invoiceAmountCents:
description: The invoice amount - in cents. This needs to be greater than
or equal to 100.
example: 1000000
type: number
invoiceDueDate:
description: The date when the invoice will be paid by the payor. ISO 8601
date format. This date must be at least 7 days in the future and must
be after the `invoiceIssuedDate`.
example: 2022-06-01
type: string
invoiceIssuedDate:
description: The date when the payee issued the invoice. ISO 8601 date format.
example: 2022-04-01
type: string
payorEmail:
description: The email of the payor.
example: user@gmail.com
type: string
payorAddress:
allOf:
- $ref: '#/components/schemas/Address'
description: "The address of the payor. The address is optional. If you\
\ provide the address, you need to provide all the required fields in\
\ the address. The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
payorType:
description: '`INDIVIDUAL` if the payor is a person and `BUSINESS` if the
payor is a company.'
enum:
- BUSINESS
- INDIVIDUAL
example: BUSINESS
type: string
payorBusinessName:
description: The registered name of the payor business when the payor is
a business and not an individual. Required and should only be defined
if `payorType` is `BUSINESS`.
example: My Business
type: string
payorFirstName:
description: The first name of the payor when the payor is an individual
and not a business. Required and should only be defined if `payorType`
is `INDIVIDUAL`.
example: John
type: string
payorMiddleName:
description: The middle name of the payor when the payor is an individual
and not a business. Optional and should only be defined if `payorType`
is `INDIVIDUAL`.
type: string
payorLastName:
description: The last name of the payor when the payor is an individual
and not a business. Required and should only be defined if `payorType`
is `INDIVIDUAL`.
example: Smith
type: string
description:
description: The description of the goods or services in the invoice.
example: Invoice for equipment purchased.
type: string
required:
- description
- invoiceAmountCents
- invoiceDueDate
- invoiceIssuedDate
- payorType
- platformInvoiceId
- platformInvoiceNumber
type: object
InvoiceFlowSessionTokenData:
example:
component: SESSION_INVOICE_FLOW
invoices:
- payorEmail: user@gmail.com
payorType: BUSINESS
description: Invoice for equipment purchased.
payorMiddleName: payorMiddleName
payorBusinessName: My Business
payorLastName: Smith
platformInvoiceId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
invoiceDueDate: 2022-06-01
payorFirstName: John
invoiceAmountCents: 1000000
payorAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
platformInvoiceNumber: "123"
invoiceIssuedDate: 2022-04-01
- payorEmail: user@gmail.com
payorType: BUSINESS
description: Invoice for equipment purchased.
payorMiddleName: payorMiddleName
payorBusinessName: My Business
payorLastName: Smith
platformInvoiceId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
invoiceDueDate: 2022-06-01
payorFirstName: John
invoiceAmountCents: 1000000
payorAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
platformInvoiceNumber: "123"
invoiceIssuedDate: 2022-04-01
properties:
component:
description: Generates a session token for the invoice confirmation flow.
This option can be used if you have all the required invoice data.
enum:
- SESSION_INVOICE_FLOW
type: string
invoices:
description: Details about the list of invoices which are to be created.
items:
$ref: '#/components/schemas/SessionInvoice'
type: array
required:
- component
- invoices
type: object
SessionInvoiceWithInvoiceFile:
properties:
platformInvoiceId:
description: Your platform’s unique ID for the invoice.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
documentId:
description: The UUID of the invoice document created in Kanmon.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
platformInvoiceNumber:
description: Your user-facing identifier for the invoice. This is unique
per issued product. This may or may not be the same as your `platformInvoiceId`.
example: "123"
type: string
invoiceAmountCents:
description: The invoice amount - in cents. This needs to be greater than
or equal to 100.
example: 1000000
type: number
invoiceDueDate:
description: The date when the invoice will be paid by the payor. ISO 8601
date format. This date must be at least 7 days in the future and must
be after the `invoiceIssuedDate`.
example: 2022-06-01
type: string
invoiceIssuedDate:
description: The date when the payee issued the invoice. ISO 8601 date format.
example: 2022-04-01
type: string
payorEmail:
description: The email of the payor.
example: user@gmail.com
type: string
payorAddress:
allOf:
- $ref: '#/components/schemas/Address'
description: "The address of the payor. The address is optional. If you\
\ provide the address, you need to provide all the required fields in\
\ the address. The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
payorType:
description: '`INDIVIDUAL` if the payor is a person and `BUSINESS` if the
payor is a company.'
enum:
- BUSINESS
- INDIVIDUAL
example: BUSINESS
type: string
payorBusinessName:
description: The registered name of the payor business when the payor is
a business and not an individual.
example: My Business
type: string
payorFirstName:
description: The first name of the payor when the payor is an individual
and not a business.
example: John
type: string
payorMiddleName:
description: The middle name of the payor when the payor is an individual
and not a business.
type: string
payorLastName:
description: The last name of the payor when the payor is an individual
and not a business.
example: Smith
type: string
description:
description: The description of the goods or services in the invoice.
example: Invoice for equipment purchased.
type: string
required:
- documentId
- platformInvoiceId
type: object
InvoiceFlowWithInvoiceFileSessionTokenData:
properties:
component:
description: Generates a session token for the invoice confirmation flow.
This option can be used if you do not have all the required invoice data
for the SESSION_INVOICE_FLOW option. Optional data that is not provided
may be collected from the user. An invoice PDF must be provided.
enum:
- SESSION_INVOICE_FLOW_WITH_INVOICE_FILE
type: string
invoices:
description: Details about the list of invoices which are to be created.
items:
$ref: '#/components/schemas/SessionInvoiceWithInvoiceFile'
type: array
required:
- component
- invoices
type: object
AccountsPayableSessionInvoice:
properties:
platformInvoiceId:
description: Your platform’s unique ID for the invoice.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
platformInvoiceNumber:
description: Your user-facing identifier for the invoice. This is unique
per issued product. This may or may not be the same as your `platformInvoiceId`.
example: "123"
type: string
invoiceAmountCents:
description: The invoice amount - in cents. This needs to be greater than
or equal to 100.
example: 1000000
type: number
invoiceDueDate:
description: "The date when the invoice will be paid by the payor. ISO 8601\
\ date format. This date must be no more than 5 days in the past. If `invoiceIssuedDate`\
\ is provided, then it must be after `invoiceIssuedDate`."
example: 2022-06-01
type: string
invoiceIssuedDate:
description: The date when the payee issued the invoice. ISO 8601 date format.
example: 2022-04-01
type: string
payeeEmail:
description: The email of the payee.
example: user@gmail.com
type: string
payeeAddress:
allOf:
- $ref: '#/components/schemas/Address'
description: "The address of the payee. The address is optional. If you\
\ provide the address, you need to provide all the required fields in\
\ the address. The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
payeeType:
description: '`INDIVIDUAL` if the payee is a person and `BUSINESS` if the
payee is a company.'
enum:
- BUSINESS
- INDIVIDUAL
example: BUSINESS
type: string
payeeBusinessName:
description: The registered name of the payee business when the payee is
a business and not an individual. Required and should only be defined
if `payeeType` is `BUSINESS`.
example: My Business
type: string
payeeFirstName:
description: The first name of the payee when the payee is an individual
and not a business. Required and should only be defined if `payeeType`
is `INDIVIDUAL`.
example: John
type: string
payeeMiddleName:
description: The middle name of the payee when the payee is an individual
and not a business. Optional and should only be defined if `payeeType`
is `INDIVIDUAL`.
type: string
payeeLastName:
description: The last name of the payee when the payee is an individual
and not a business. Required and should only be defined if `payeeType`
is `INDIVIDUAL`.
example: Smith
type: string
description:
description: The description of the goods or services in the invoice.
example: Invoice for equipment purchased.
type: string
required:
- description
- invoiceAmountCents
- invoiceDueDate
- payeeType
- platformInvoiceId
- platformInvoiceNumber
type: object
AccountsPayableInvoiceFlowSessionTokenData:
properties:
component:
description: Generates a session token for the accounts payable invoice
confirmation flow. This option can be used if you have all the required
invoice data.
enum:
- SESSION_ACCOUNTS_PAYABLE_INVOICE_FLOW
type: string
invoices:
description: Details about the list of invoices which are to be created.
items:
$ref: '#/components/schemas/AccountsPayableSessionInvoice'
type: array
required:
- component
- invoices
type: object
AccountsPayableSessionInvoiceWithInvoiceFile:
properties:
platformInvoiceId:
description: Your platform’s unique ID for the invoice.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
documentId:
description: The UUID of the invoice document created in Kanmon.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
platformInvoiceNumber:
description: Your user-facing identifier for the invoice. This is unique
per issued product. This may or may not be the same as your `platformInvoiceId`.
example: "123"
type: string
invoiceAmountCents:
description: The invoice amount - in cents. This needs to be greater than
or equal to 100.
example: 1000000
type: number
invoiceDueDate:
description: "The date when the invoice will be paid by the payor. ISO 8601\
\ date format. This date must be no more than 5 days in the past. If `invoiceIssuedDate`\
\ is provided, then it must be after `invoiceIssuedDate`."
example: 2022-06-01
type: string
invoiceIssuedDate:
description: The date when the payee issued the invoice. ISO 8601 date format.
example: 2022-04-01
type: string
payeeEmail:
description: The email of the payee.
example: user@gmail.com
type: string
payeeAddress:
allOf:
- $ref: '#/components/schemas/Address'
description: "The address of the payee. The address is optional. If you\
\ provide the address, you need to provide all the required fields in\
\ the address. The address must be a street address, not a PO Box."
example:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
payeeType:
description: '`INDIVIDUAL` if the payee is a person and `BUSINESS` if the
payee is a company.'
enum:
- BUSINESS
- INDIVIDUAL
example: BUSINESS
type: string
payeeBusinessName:
description: The registered name of the payee business when the payee is
a business and not an individual.
example: My Business
type: string
payeeFirstName:
description: The first name of the payee when the payee is an individual
and not a business.
example: John
type: string
payeeMiddleName:
description: The middle name of the payee when the payee is an individual
and not a business.
type: string
payeeLastName:
description: The last name of the payee when the payee is an individual
and not a business.
example: Smith
type: string
description:
description: The description of the goods or services in the invoice.
example: Invoice for equipment purchased.
type: string
required:
- documentId
- platformInvoiceId
type: object
AccountsPayableInvoiceFlowWithInvoiceFileSessionTokenData:
properties:
component:
description: Generates a session token for the accounts payable invoice
confirmation flow. This option can be used if you do not have all the
required invoice data for the SESSION_ACCOUNTS_PAYABLE_INVOICE_FLOW option.
Optional data that is not provided may be collected from the user. An
invoice PDF must be provided.
enum:
- SESSION_ACCOUNTS_PAYABLE_INVOICE_FLOW_WITH_INVOICE_FILE
type: string
invoices:
description: Details about the list of invoices which are to be created.
items:
$ref: '#/components/schemas/AccountsPayableSessionInvoiceWithInvoiceFile'
type: array
required:
- component
- invoices
type: object
CreateSessionTokenRequestBody:
example:
platformBusinessId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
data:
component: SESSION_INVOICE_FLOW
invoices:
- payorEmail: user@gmail.com
payorType: BUSINESS
description: Invoice for equipment purchased.
payorMiddleName: payorMiddleName
payorBusinessName: My Business
payorLastName: Smith
platformInvoiceId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
invoiceDueDate: 2022-06-01
payorFirstName: John
invoiceAmountCents: 1000000
payorAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
platformInvoiceNumber: "123"
invoiceIssuedDate: 2022-04-01
- payorEmail: user@gmail.com
payorType: BUSINESS
description: Invoice for equipment purchased.
payorMiddleName: payorMiddleName
payorBusinessName: My Business
payorLastName: Smith
platformInvoiceId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
invoiceDueDate: 2022-06-01
payorFirstName: John
invoiceAmountCents: 1000000
payorAddress:
city: San Mateo
state: CA
country: USA
zipcode: "94401"
addressLineOne: 123 Main Street
platformInvoiceNumber: "123"
invoiceIssuedDate: 2022-04-01
businessId: adbcccf9-3a7f-4040-add3-55c9d6da2d37
properties:
businessId:
description: The unique identifier for business within Kanmon. Either of
`businessId` or `platformBusinessId` is required.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
platformBusinessId:
description: The unique identifier for business in your platform. Either
of `businessId` or `platformBusinessId` is required.
example: adbcccf9-3a7f-4040-add3-55c9d6da2d37
type: string
data:
$ref: '#/components/schemas/CreateSessionTokenRequestBody_data'
required:
- data
type: object
EmbeddedSession:
example:
sessionToken: sessionToken
properties:
sessionToken:
description: The session token used to launch an embedded session.
type: string
required:
- sessionToken
type: object
BusinessHasNoPrimaryOwnerException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- BusinessHasNoPrimaryOwnerException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
PrimaryBusinessOwnerAlreadyExistsWithEmailException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- PrimaryBusinessOwnerAlreadyExistsWithEmailException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
PrimaryBusinessOwnerNotFoundException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- PrimaryBusinessOwnerNotFoundException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
UnmergeableBusinessException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- UnmergeableBusinessException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
UserAlreadyExistsWithEmailException:
example:
errorCode: UserAlreadyExistsWithEmailException
message: An error occurred.
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- UserAlreadyExistsWithEmailException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
UserAlreadyExistsWithPlatformUserIdException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- UserAlreadyExistsWithPlatformUserIdException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
BusinessHasNoInvoiceFinancingProductException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- BusinessHasNoInvoiceFinancingProductException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
BusinessHasNoAccountsPayableFinancingProductException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- BusinessHasNoAccountsPayableFinancingProductException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
InvalidInvoiceDueDateException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- InvalidInvoiceDueDateException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
InvoiceNotFoundException:
example:
errorCode: InvoiceNotFoundException
message: Internal Server Error
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- InvoiceNotFoundException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
OfferAlreadySelectedException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- OfferAlreadySelectedException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
OfferNotLockedException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- OfferNotLockedException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
SomeOffersHaveExpiredException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- SomeOffersHaveExpiredException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
PlatformInvoiceIdAlreadyExistsForAnotherIssuedProductException:
example:
errorCode: PlatformInvoiceIdAlreadyExistsForAnotherIssuedProductException
message: An error occurred.
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- PlatformInvoiceIdAlreadyExistsForAnotherIssuedProductException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
BankStatementsInvalidException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- BankStatementsInvalidException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
PlaidAssetReportsInvalidException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- PlaidAssetReportsInvalidException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
CheckingAccountRequiredException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- CheckingAccountMustPresentException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
BusinessPlaidBankAccountNotFoundException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- BusinessPlaidBankAccountNotFoundException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
IncorrectProductTypeException:
example:
errorCode: IncorrectProductTypeException
message: Internal Server Error
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- IncorrectProductTypeException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
IntegratedMcaReceivableAlreadyExistsException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- IntegratedMcaReceivableAlreadyExistsException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
NoRemainingBalanceException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- NoRemainingBalanceException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
IncorrectRepaymentAmountException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- IncorrectRepaymentAmountException
type: string
message:
description: The human readable description of the error.
example: Internal Server Error
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
CustomInitializationNotFoundException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- CustomInitializationNotFoundException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
IssuedProductStatusNotCurrentException:
example:
errorCode: IssuedProductStatusNotCurrentException
message: Issued product status must be CURRENT.
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- IssuedProductStatusNotCurrentException
type: string
message:
description: The human readable description of the error.
example: Issued product status must be CURRENT.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
InvoicePaymentPlanNotFoundException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- InvalidInvoicePaymentPlanException
type: string
message:
description: The human readable description of the error.
example: Invoice payment plan id must be valid.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
InsufficientCreditLimitException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- InsufficientCreditLimitException
type: string
message:
description: The human readable description of the error.
example: Available credit limit must be greater than or equal to the requested
financing amount.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
IncorrectFinancingAmountException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- IncorrectFinancingAmountException
type: string
message:
description: The human readable description of the error.
example: The amount requested for financing must equal the invoice amount.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
PlatformInvoiceIdAlreadyExistsException:
example:
errorCode: PlatformInvoiceIdAlreadyExistsException
message: An error occurred.
timestamp: 2022-06-01T03:57:26.115Z
properties:
errorCode:
description: Safe for programmatic use.
enum:
- PlatformInvoiceIdAlreadyExistsException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
PlatformInvoiceNumberAlreadyExistsForIssuedProductException:
properties:
errorCode:
description: Safe for programmatic use.
enum:
- PlatformInvoiceNumberAlreadyExistsForIssuedProductException
type: string
message:
description: The human readable description of the error.
example: An error occurred.
type: string
timestamp:
description: When the error occurred - ISO 8601 format.
example: 2022-06-01T03:57:26.115Z
type: string
required:
- errorCode
- message
- timestamp
type: object
createBusiness_404_response:
oneOf:
- $ref: '#/components/schemas/BusinessNotFoundException'
- $ref: '#/components/schemas/CustomInitializationNotFoundException'
createUser_409_response:
oneOf:
- $ref: '#/components/schemas/PrimaryBusinessOwnerAlreadyExistsForBusinessException'
- $ref: '#/components/schemas/UserAlreadyExistsWithPlatformUserIdException'
- $ref: '#/components/schemas/UserAlreadyExistsWithEmailException'
updateUser_409_response:
oneOf:
- $ref: '#/components/schemas/UserAlreadyExistsWithEmailException'
- $ref: '#/components/schemas/PrimaryBusinessOwnerAlreadyExistsForBusinessException'
getInvoice_404_response:
oneOf:
- $ref: '#/components/schemas/InvoiceNotFoundException'
- $ref: '#/components/schemas/BusinessNotFoundException'
financeInvoice_400_response:
oneOf:
- $ref: '#/components/schemas/PlatformInvoiceIdAlreadyExistsException'
- $ref: '#/components/schemas/InvoicePaymentPlanNotFoundException'
- $ref: '#/components/schemas/InvalidInvoiceDueDateException'
- $ref: '#/components/schemas/IncorrectFinancingAmountException'
financeInvoice_404_response:
oneOf:
- $ref: '#/components/schemas/IssuedProductNotFoundException'
- $ref: '#/components/schemas/InvoicePaymentPlanNotFoundException'
financeInvoice_409_response:
oneOf:
- $ref: '#/components/schemas/IssuedProductStatusNotCurrentException'
- $ref: '#/components/schemas/IncorrectProductTypeException'
- $ref: '#/components/schemas/InsufficientCreditLimitException'
createIntegratedMcaReceivable_400_response:
oneOf:
- $ref: '#/components/schemas/BadRequestException'
- $ref: '#/components/schemas/NoRemainingBalanceException'
- $ref: '#/components/schemas/IncorrectRepaymentAmountException'
createIntegratedMcaReceivable_409_response:
oneOf:
- $ref: '#/components/schemas/IncorrectProductTypeException'
- $ref: '#/components/schemas/IntegratedMcaReceivableAlreadyExistsException'
createEmbeddedSession_409_response:
oneOf:
- $ref: '#/components/schemas/PlatformInvoiceIdAlreadyExistsForAnotherIssuedProductException'
- $ref: '#/components/schemas/BusinessHasNoInvoiceFinancingProductException'
InvoicePaymentPlan_repaymentWindow:
description: The repayment window
oneOf:
- $ref: '#/components/schemas/FixedDateInvoiceRepaymentWindow'
- $ref: '#/components/schemas/FixedDurationInvoiceRepaymentWindow'
- $ref: '#/components/schemas/MultipleDurationInvoiceRepaymentWindow'
Offer_terms:
description: Terms of the offer.
discriminator:
mapping:
TERM_LOAN: '#/components/schemas/TermLoanOfferTerms'
INVOICE_FINANCING: '#/components/schemas/InvoiceFinancingOfferTerms'
MCA: '#/components/schemas/McaOfferTerms'
INTEGRATED_MCA: '#/components/schemas/IntegratedMcaOfferTerms'
LINE_OF_CREDIT: '#/components/schemas/LineOfCreditOfferTerms'
ACCOUNTS_PAYABLE_FINANCING: '#/components/schemas/InvoiceFinancingOfferTerms'
propertyName: productType
oneOf:
- $ref: '#/components/schemas/TermLoanOfferTerms'
- $ref: '#/components/schemas/InvoiceFinancingOfferTerms'
- $ref: '#/components/schemas/McaOfferTerms'
- $ref: '#/components/schemas/IntegratedMcaOfferTerms'
- $ref: '#/components/schemas/LineOfCreditOfferTerms'
IssuedProduct_servicingData:
description: The data needed to service this specific type of issued product
discriminator:
mapping:
TERM_LOAN: '#/components/schemas/TermLoanServicingData'
INVOICE_FINANCING: '#/components/schemas/InvoiceFinancingServicingData'
MCA: '#/components/schemas/McaServicingData'
INTEGRATED_MCA: '#/components/schemas/IntegratedMcaServicingData'
LINE_OF_CREDIT: '#/components/schemas/LineOfCreditServicingData'
ACCOUNTS_PAYABLE_FINANCING: '#/components/schemas/InvoiceFinancingServicingData'
propertyName: productType
oneOf:
- $ref: '#/components/schemas/TermLoanServicingData'
- $ref: '#/components/schemas/InvoiceFinancingServicingData'
- $ref: '#/components/schemas/McaServicingData'
- $ref: '#/components/schemas/IntegratedMcaServicingData'
- $ref: '#/components/schemas/LineOfCreditServicingData'
CreateSessionTokenRequestBody_data:
description: This will differ depending on which `component` is used.
discriminator:
mapping:
SESSION_INVOICE_FLOW: '#/components/schemas/InvoiceFlowSessionTokenData'
SESSION_INVOICE_FLOW_WITH_INVOICE_FILE: '#/components/schemas/InvoiceFlowWithInvoiceFileSessionTokenData'
SESSION_ACCOUNTS_PAYABLE_INVOICE_FLOW: '#/components/schemas/AccountsPayableInvoiceFlowSessionTokenData'
SESSION_ACCOUNTS_PAYABLE_INVOICE_FLOW_WITH_INVOICE_FILE: '#/components/schemas/AccountsPayableInvoiceFlowWithInvoiceFileSessionTokenData'
propertyName: component
oneOf:
- $ref: '#/components/schemas/InvoiceFlowSessionTokenData'
- $ref: '#/components/schemas/InvoiceFlowWithInvoiceFileSessionTokenData'
- $ref: '#/components/schemas/AccountsPayableInvoiceFlowSessionTokenData'
- $ref: '#/components/schemas/AccountsPayableInvoiceFlowWithInvoiceFileSessionTokenData'
securitySchemes:
Authorization:
in: header
name: Authorization
type: apiKey