Repayment Resources
This page provides an overview of the repayment resource types available in the Unit API.
Repayment Types
Unit supports multiple repayment resource types, each designed for different use cases:
| Resource Type | Description | Use Case |
|---|---|---|
| AchRepayment | Repayment via ACH debit from an external bank account | When funds are pulled from accounts at other banks integrated with Unit |
| BookRepayment | Repayment via internal book transfer | When funds are transferred from a deposit account at the same bank partner |
| CapitalPartnerAchRepayment | ACH repayment directed to a Capital Partner's account | When using Unit Capital and repayments should go to the Capital Partner |
| CapitalPartnerBookRepayment | Book repayment directed to a Capital Partner's account | When using Unit Capital with funds from the same bank partner |
| ExternalRepayment | Ledger-only repayment for funds collected externally | When money movement occurs outside the Unit platform |
Resource Schemas
ACH Repayment
An ACH Repayment represents a repayment initiated via ACH debit from an external counterparty account.
See the full schema at AchRepayment Resource.
Book Repayment
A Book Repayment represents an internal transfer from a deposit account at the same bank partner to pay down a credit account balance.
See the full schema at BookRepayment Resource.
Capital Partner ACH Repayment
A Capital Partner ACH Repayment is used when Unit Capital is providing the funds for the lending program and repayments are collected via ACH.
See the full schema at CapitalPartnerAchRepayment Resource.
Capital Partner Book Repayment
A Capital Partner Book Repayment is used when Unit Capital is providing the funds and repayments are made via internal book transfer.
See the full schema at CapitalPartnerBookRepayment Resource.
External Repayment
An External Repayment is used to record repayments where the actual money movement occurs outside of the Unit platform. This only updates the credit ledger.
See the full schema at ExternalRepayment Resource.
Common Attributes
All repayment resources share these common attributes:
| Attribute | Type | Description |
|---|---|---|
| id | string | Unique identifier for the repayment |
| type | string | The repayment type (e.g., achRepayment, bookRepayment, externalRepayment) |
| status | string | Current status of the repayment |
| createdAt | string | ISO 8601 timestamp of when the repayment was created |
| updatedAt | string | ISO 8601 timestamp of when the repayment was last updated |
| amount | integer | The repayment amount in cents |
| tags | object | Optional custom metadata |
Common Relationships
| Relationship | Description |
|---|---|
| creditAccount | The Credit Account that the repayment is made against |
| customer | The Customer associated with the repayment |
| payment | The underlying Payment resource (for native repayments) |
| transaction | The Transaction created by the repayment |
For complete schema definitions and all available attributes, see the Resources API reference.