---
title: Enums
slug: apis/lending/enums
description: Reference file for loan, rail, and funding enums (loan statuses, rail types, funding results); used across the loan APIs
docTags:
createdAt: 2024-08-14T11:59:41.070Z
---
## LoanStatusEnum
These enums communicate the status of a loan.
| Enums | Enum number | Description |
| --------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Received` | 1 | Arix received a new loan application.
Send attachments as the next step in the process. |
| `DocsComplete` | 2 | All required documents were received |
| `PassedCompliance` | 3 | Loan successfully passed compliance |
| `Approved` | 4 | Loan was approved for funding |
| `InFunding` | 5 | At least 1 rail was submitted for funding |
| `Funded` | 6 | Full loan amount was funded |
| `AccountingEntriesComplete` | 7 | An internal Cross River process. Confirms that account entries are complete. |
| `ReadyToSell` | 8 | Loan finished the seasoning period and is ready to be sold (not in use)
Use the `ReadyForPurchase` status from [LoanSaleStatusUpdated](docId\:hpq_QWOAKV9JprqwkFR1I) |
| `Sold` | 9 | Loan was sold (not in use)
Sale info is on the post-purchase report in SFTP |
| `Settled` | 10 | Loan was paid back by end user (not in use) |
| `AwaitingFunding` | 11 | All compliance rules were passed and the system is waiting for the funding information. Once in this status, only a `PUT /FundingInfo` will get the loan funded. |
| `InReverse` | 80 | A return/ cancel has been requested, and the funding is being returned to the originating account. |
| `AccountingEntriesReversed` | 90 | *Internal status*
Loan was canceled or fully returned and accounting entries were reversed. |
| `Cancelled` | 100 | Issuing bank canceled the loan. **Terminal State** |
| `ComplianceFailed` | 101 | Loan failed the compliance check |
| `Rejected` | 102 | Issuing bank didn't approve - possible only prior to funding. **Terminal State**. |
| `Returned` | 103 | All rails that were successfully funded came back as returned |
| `NotFullyFunded` | 104 | Funding was attempted, but a balance remains to be funded |
## FundingResult enums
These enums communicate the results of a funding attempt.
| Enums | Enum number | Description |
| ---------------- | ----------- | -------------------------------------------------- |
| `Success` | 0 | All funded |
| `PartialFailure` | 1 | Some funds were sent successfully, but some failed |
| `FundingFailed` | 2 | Funding failed and nothing was funded |
## RailResultType enums
These enums communicate the results of a rail transaction as part of the funding attempt.
| Enums | Enum number | Description |
| ------------------------------------ | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `NotAttemptd` | 0 | Rail wasn't attempted |
| `Requested` | 1 | API call was successful and the funds are pending transmission |
| `Success` | 2 | Full requested amount has been funded and released on the rail.
**Note:** There is lag time between the time an ACH is sent and when it is received (by the receiving bank), usually 1 business day (unless it was sent as a same-day ACH).
Cross River considers the rail a **`success`** if and until we receive a notice from the receiving bank that the rail failed. At that time, the status of the rail changes from **`Success`** to **`Returned`**. |
| `RequestFailure` | 3 | The request to fund failed immediately upon request (usually due to a mistake in the API instructions.) |
| `Rejected` | 4 | The rail was rejected |
| `Returned` | 5 | The rail that was sent and marked as **`success`** was returned. |
| `Skipped` | 6 | A rail was skipped. No need to reattempt the funding. |
| `ValidationFail` | 7 | The rail failed because it could not be validated |
| `CosAchPaymentRejected` | 8 | Arix received a notification that a specific ACH rail was rejected
(*Internal Ops*) |
| `CosAchPaymentCanceled` | 9 | Cross River Ops canceled the ACH payment
(*Internal Ops*) |
| `CosAchNocReceived` | 10 | A Notice of Change (NOC) was received. Relevant for recurrent disbursements.
(*Internal Ops*)
Contact customer for updated instructions. |
| `CosAchHoldEscalated` | 11 | Cross River Ops put the ACH transaction on hold
(*Internal Ops*) |
| `CosCoreTransactionCompleted` | 12 | COS Core (part of XPay) transaction was completed successfully
(*Internal Ops*) |
| `CosCoreTransactionRejected` | 13 | COS Core (part of XPay) transaction was unable to complete
(*Internal Ops*) |
| `CosXPaymentReceived` | 15 | Inbound payment request has been received and is awaiting approval
(*Internal Ops*) |
| `CosXPaymentCanceled` | 16 | Payment canceled at the sender's request or has expired
(*Internal Ops*) |
| `CosXPaymentRejected` | 17 | Payment was rejected by the receiver
(*Internal Ops*)
|
| `CosXPaymentFailed` | 18 | Payment failed to post to either the sender or receiver's account.
Most commonly due to insufficient funds (*Internal Ops*) |
| `CosXPaymentCompleted` | 19 | Payment has been posted to both the sender and receiver's accounts
(*Internal Ops*) |
| `CosCoreTransactionCompletedReverse` | 20 | COS Core (part of XPay) reversal transaction has been completed
(*Internal Ops*) |
| `CosXPaymentRejectedReverse` | 24 | COS XPay requested reversal hasn't been approved
(*Internal Ops*) |
| `CosXPaymentFailedReverse` | 25 | COS XPay requested reversal was unable to be reversed
(Internal Ops) |
| `CosXPaymentCanceledReverse` | 26 | COS XPay reversal was canceled
(*Internal Ops*) |
| `CheckCashed` | 27 | Check was cashed |
| `CheckPrinted` | 28 | Check was printed
(Not in use) |
| `DigitalCheckPrinted` | 29 | A digital check was printed
(Not in use) |
| `CheckMailed` | 30 | The check was mailed |
| `Failed` | 31 | The check was not able to be cashed |
| `Cancelled` | 32 | Rail was cancelled |
| `OnHold` | 33 | Payment is on hold. |
| `PullReturned`
| 34 | The Pull Funding was returned. This will cause the balance of the loan to increase. **The partner should review this loan and check for over funding by looking at the total amount of rails sent out. Contact Cross River if this is the case. **
**Additional information:**[Pull funding (ACH debit) rail](docId\:WBnY56dNE7PhLG2XJqPOq) |
| `ShippingTrackingAdded` | 35 | A tracking number has been added for the Check that has been sent. |
## RailType enums
These enums communicate the type of rail used to make the transactions.
| Enums | Enum number | Description |
| ------------------ | ----------- | ----------------------------------------- |
| `RPPS` | 4 | RPPS rail |
| `NF` | 7 | No funding |
| `COSACH` | 8 | Next day funding via ACH |
| `COSACHSD` | 9 | Same day funding via ACH |
| `COSXPay` | 10 | Internal transfer between CR accounts |
| `AdjustmentAction` | 20 | Adjustments to a loan after it was funded |
| `Check` | 30 | Physical check |
| `RTP` | 40 | Real Time Payments |
| `Card` | 50 | Card |
| `Wire` | 60 | Wire |
## RPPS enums
RPPS uses enums to return funding attempt results.
| Enum name | Enum number | Description |
| ----------- | ----------- | ----------------------------------------- |
| `Received` | 1 | The funding attempt was received by RPPS |
| `Submitted` | 2 | The funding attempt was submitted by RPPS |
| `Pending` | 3 | The funding attempt is pending |
| `Approved` | 4 | The funding attempt was approved by RPPS |
| `Rejected` | 5 | The funding attempt was rejected by RPPS |
| `Failed` | 6 | The funding attempt failed in RPPS |
| `Returned` | 7 | The rail was returned by RPPS |
## LoanSaleStatusUpdated
These enums communicate the status of the loan within CRB financial warehouse.
| Enum name | Enum number | Description |
| --------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------- |
| `Pending` | 0 | Loan seasoning is pending |
| `InSeasoning` | 1 | The loan has been funded and is in seasoning |
| `ReadyForPurchase` | 2 | Loan seasoning completed and the loan is available for purchase |
| `PurchaseRequested` | 3 | Purchase has been requested but is not yet complete |
| `RemovedFromSeasoning` | 4 | The loan was removed from seasoning, transitioning to `ReadyForPurchase` |
| `Purchased` | 5 | The loan has been purchased |
| `Canceled` | 6 | The loan was canceled |
| `AwaitingInvestorAllocation` | 7 | The loan is pending allocation |
| `InGroomingAwaitingAccounts` | 10 | A change to the loan financial arrangement (loan type) was requested, awaiting accounts |
| `InGroomingAwaitingRetroactiveInterest` | 11 | A change to the loan financial arrangement (loan type) was requested, interest being recalculated |