Recurring Repayment Resources
This page provides an overview of the recurring repayment resource types available in the Unit API.
Recurring Repayment Types
Unit supports multiple recurring repayment resource types, each designed for different use cases:
| Resource Type | Description | Use Case |
|---|---|---|
| RecurringAchRepayment | Recurring repayment via ACH debit from an external bank account | When funds are periodically pulled from accounts at other banks integrated with Unit |
| RecurringBookRepayment | Recurring repayment via internal book transfer | When funds are periodically transferred from a deposit account at the same bank partner |
| RecurringCapitalPartnerAchRepayment | Recurring ACH repayment directed to a Capital Partner's account | When using Unit Capital and recurring repayments should go to the Capital Partner |
| RecurringCapitalPartnerBookRepayment | Recurring book repayment directed to a Capital Partner's account | When using Unit Capital with funds from the same bank partner |
Resource Schemas
Recurring ACH Repayment
A Recurring ACH Repayment represents an automated recurring repayment initiated via ACH debit from an external counterparty account.
See the full schema at RecurringAchRepayment Resource.
Recurring Book Repayment
A Recurring Book Repayment represents an automated recurring internal transfer from a deposit account at the same bank partner to pay down a credit account balance.
See the full schema at RecurringBookRepayment Resource.
Recurring Capital Partner ACH Repayment
A Recurring Capital Partner ACH Repayment is used when Unit Capital is providing the funds for the lending program and recurring repayments are collected via ACH.
See the full schema at RecurringCapitalPartnerAchRepayment Resource.
Recurring Capital Partner Book Repayment
A Recurring Capital Partner Book Repayment is used when Unit Capital is providing the funds and recurring repayments are made via internal book transfer.
See the full schema at RecurringCapitalPartnerBookRepayment Resource.
Common Attributes
All recurring repayment resources share these common attributes:
| Attribute | Type | Description |
|---|---|---|
| id | string | Unique identifier for the recurring repayment |
| type | string | The recurring repayment type (e.g., recurringAchRepayment, recurringBookRepayment) |
| status | string | Current status of the recurring repayment (Active or Disabled) |
| createdAt | string | ISO 8601 timestamp of when the recurring repayment was created |
| updatedAt | string | ISO 8601 timestamp of when the recurring repayment was last updated |
| schedule | object | The repayment schedule configuration |
| description | string | Description that appears on the statement |
| tags | object | Optional custom metadata |
Common Relationships
| Relationship | Description |
|---|---|
| creditAccount | The Credit Account that the repayments are made against |
| customer | The Customer associated with the recurring repayment |
| account | The Deposit Account where repayment funds are deposited (for non-Capital Partner repayments) |
| counterparty | The ACH Counterparty the repayment funds come from (for ACH repayments) |
| counterpartyAccount | The Deposit Account the repayment funds are taken from (for Book repayments) |
For complete schema definitions and all available attributes, see the Resources API reference.