{{foobar}}
", "nullable": true, "type": "string" }, "ContentTextTemplate": { "description": "A valid Jinja template to use for the content text body. This is used, for instance,\nfor the body of a plain text email or text message.\n", "example": "Hello {{foobar}}", "nullable": true, "type": "string" }, "TemplateVersionStatus": { "enum": [ "draft", "deployed", "deprecated" ], "type": "string" }, "SubjectLineTemplate": { "description": "A valid Jinja template to use for the subject line. This is used, for instance,\nfor the subject line when sending emails.\n\nThis is simply ignored when the channel does not need a subject.\n\nThe context variables available to this template are the same as the context available to \n`contentTextTemplate`\n", "example": "Hello {{foobar}}", "nullable": true, "type": "string" }, "TemplateVersionMutate": { "additionalProperties": false, "properties": { "contentHtmlTemplate": { "$ref": "#/components/schemas/ContentHtmlTemplate" }, "contentTextTemplate": { "$ref": "#/components/schemas/ContentTextTemplate" }, "descriptorId": { "$ref": "#/components/schemas/TemplateDescriptorId" }, "status": { "$ref": "#/components/schemas/TemplateVersionStatus" }, "subjectLineTemplate": { "$ref": "#/components/schemas/SubjectLineTemplate" } } }, "TemplateVersion": { "allOf": [ { "properties": { "id": { "$ref": "#/components/schemas/TemplateVersionId" } }, "type": "object" }, { "$ref": "#/components/schemas/TemplateVersionMutate" } ] }, "OneTimeCodeChannel": { "description": "The channel via which to send the one time code through.\n", "enum": [ "email", "text", "voice" ], "type": "string" }, "CollectionAgencyCreate": { "allOf": [ { "$ref": "#/components/schemas/BaseWithExternalIdMixin" }, { "properties": { "companyId": { "description": "The unique company identifier.\n", "readOnly": true, "type": "string" }, "contactEmail": { "description": "The third party debt collection agency email address that the charged-off loan was assigned to.\n", "type": "string" }, "contactPhone": { "description": "The third party debt collection agency primary phone that the charged-off loan was assigned to. Should be provided in E.164 format.\n", "type": "string" }, "legalName": { "description": "The third party debt collection agency name that the charged-off loan was assigned to.\n", "type": "string" }, "mailingAddress": { "$ref": "#/components/schemas/AddressBase", "description": "The third party debt collection agency mailing address that the charged-off loan was assigned to.\n" } }, "type": "object" } ] }, "CollectionAgency": { "allOf": [ { "$ref": "#/components/schemas/CollectionAgencyCreate" }, { "properties": { "isArchived": { "description": "Set to true if the debt collection agency no longer active. Loans that were assigned to that agency will keep the reference, but new loans cannot be assigned.\n", "type": "boolean" } }, "type": "object" } ] }, "CollectionAgencyPost": { "allOf": [ { "$ref": "#/components/schemas/CollectionAgencyCreate" }, { "properties": { "mailingAddress": { "allOf": [ { "$ref": "#/components/schemas/AddressBase" }, { "required": [ "addressLine1", "city", "state", "postalCode", "country" ], "type": "object" } ] } }, "type": "object" } ] }, "AgencyName": { "description": "The credit agency name.\n", "enum": [ "experian", "equifax", "transUnion", "innovis" ], "type": "string" }, "CreditAgency": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "agencyName": { "$ref": "#/components/schemas/AgencyName" }, "companyId": { "description": "The unique company identifier.\n", "readOnly": true, "type": "string" }, "country": { "description": "The credit agency country.", "maxLength": 2, "type": "string" }, "dataFormat": { "description": "The format of the reported data and file.", "enum": [ "metro2" ], "type": "string" }, "encryptionMethod": { "description": "The encryption method that Peach system with use to encrypt the files.\n", "enum": [ "GPG" ], "nullable": true, "type": "string" }, "fileNamePrefix": { "description": "The file name prefix. Must be provided if `agencyName=experian` and `nameFilePerAgencyConvention=true`. Only used if `agencyName=experian` and `nameFilePerAgencyConvention=true`.\n", "type": "string" }, "isPeachAggregator": { "default": false, "description": "**DEPRECATED ATTRIBUTE**\n\nThis field is deprecated, and is only included to remain backward compatible. Only send `false`.\n", "type": "boolean" }, "nameFilePerAgencyConvention": { "default": true, "description": "If `true` Peach system will name the file based on the credit agency convention.\n\n**Equifax**: Company legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt.\nFor example: `PEACHFINANCEINCCPYL69X5Z1EQUIFAX20211021.txt`.\n\n**Experian**: `fileNamePrefix` + `.` + today's date MMDDYYYY + .txt.\nFor example: MKFRT.10262021.txt.\n\n**TransUnion**: Company legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt.\nFor example: `PEACHFINANCEINCCPYL69X5Z1TRANSUNION20211213.txt`.\n\nIf `false` Peach system will name the file as:\nCompany legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt\nFor example: `PEACHFINANCEINCCPYL69X5Z1EXPERIAN20211021.txt`\n", "type": "boolean" }, "publicKey": { "description": "The lender's public key to use to encrypt the files. A value must be passed if encryptionMethod is set.", "nullable": true, "type": "string" }, "sftpAccessMethod": { "default": "usernamePassword", "description": "If `usernamePassword`, then `sftpUsername` and `sftpPassword` must be provided.\n\nIf `keys`, then `sftpSSHPeachPrivateKey` and `sftpSSHPeachPublicKey` will be created by peach.\n", "enum": [ "usernamePassword", "keys" ], "type": "string" }, "sftpCdDir": { "description": "Change directory into this folder before performing the upload.\n", "type": "string" }, "sftpHostname": { "description": "The SFTP hostname. If SFTP hostname, username, and password are set, they will be used instead of the default credit bureau credentials.\nHost name should not contain a scheme, so don't put `sftp://` on the front. You may optionally specify a port like so: `example.com:222`.\nIf no port is supplied a default of 22 will be used.\n", "nullable": true, "pattern": "^[^/]+$", "type": "string" }, "sftpPassword": { "description": "The password for SFTP.\n", "nullable": true, "type": "string" }, "sftpUsername": { "description": "The username for SFTP.\n", "nullable": true, "type": "string" }, "specificDays": { "description": "Specific days designate the day(s) when to upload the credit reporting file. Only the 1st day of the month is currently supported.\n\nThe allowed values for specific day(s) depends on the uploadFrequency.\n`monthly` - provide one number in the valid range 1-31. 1=first day of a month. Use 31 to indicate the last day of a month.\n\nFor example: [1].\n", "items": { "type": "integer" }, "type": "array" }, "uploadFrequency": { "description": "The credit reporting file creation frequency. Only monthly is currently supported.", "enum": [ "monthly" ], "type": "string" }, "useLoanExternalId": { "default": true, "description": "Indicates what identifier to use as an account identifier for credit reporting.\n\nIf `true`, the system will use loan `externalId` as an account identifier for credit reporting. If `externalId` doesn't exist the system will use loan Peach Public ID.\n\nIf `false`, the system will use loan Peach Public ID (e.g. LN-JFU3-ER3S) as an account identifier for credit reporting.\n", "type": "boolean" } }, "type": "object" } ] }, "CallSummaryResultStatus": { "description": "The status of the call summary result.", "enum": [ "pending", "completed", "failed" ], "type": "string" }, "CallSummaryResult": { "allOf": [ { "$ref": "#/components/schemas/BaseWithExternalIdMixin" }, { "properties": { "companyId": { "description": "The unique company identifier.", "type": "string" }, "object": { "default": "AICallSummaryResult", "enum": [ "AICallSummaryResult" ], "type": "string" }, "status": { "$ref": "#/components/schemas/CallSummaryResultStatus" }, "summary": { "description": "The summary of the call.", "nullable": true, "type": "string" }, "transcriptionResultId": { "description": "The unique identifier for the call transcription result.", "type": "string" } }, "type": "object" } ], "description": "Represents the result of a call summary." }, "CallSummaryResultsPaging": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/CallSummaryResult" }, "type": "array" } }, "type": "object" } ] }, "InteractionsManyNoPaging": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Interaction" }, "type": "array" }, "message": { "type": "string" }, "status": { "description": "HTTP status code.", "type": "integer" } }, "type": "object" }, "InvestorImmutableFields": { "properties": { "currency": { "description": "The currency that the investor will receive settlements in. Use ISO currency codes.\n\nSet to `USD` for all investors, other currencies are not supported yet.\n", "readOnly": true, "type": "string" }, "externalId": { "description": "A lender's identifier for the investor.", "type": "string" }, "id": { "description": "The investor ID", "readOnly": true, "type": "string" }, "legalName": { "description": "The legal name of the investor.", "type": "string" } }, "type": "object" }, "ValidAddress": { "description": "Identifies the address as valid or invalid.", "readOnly": true, "type": "boolean" }, "InvestorMutableFields": { "properties": { "address": { "$ref": "#/components/schemas/Address" }, "contactEmail": { "description": "The email of the investor's primary contact person.", "format": "email", "type": "string" }, "contactName": { "description": "The name of the investor's primary contact person.", "type": "string" }, "contactPhone": { "description": "The phone number of the investor's primary contact person.", "maxLength": 15, "type": "string" }, "default": { "default": false, "description": "Mark this investor as the default investor.\n\nAt loan creation, if no investors are specified in the `atOrigination.investors` attribute, the investor with `default=true` is\nadded with `shares=1` (100%).\n\nIf a new investor is created and there is another investor with `default=true`, the system will set `default=false` for the other investor.\n", "type": "boolean" }, "validAddress": { "$ref": "#/components/schemas/ValidAddress" } }, "type": "object" }, "Investor": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "$ref": "#/components/schemas/InvestorImmutableFields" }, { "$ref": "#/components/schemas/InvestorMutableFields" } ], "required": [ "legalName" ], "title": "Investor" }, "InvestorMutable": { "allOf": [ { "$ref": "#/components/schemas/InvestorMutableFields" } ], "title": "Investor" }, "PaymentInstrumentImmutableFields": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "activeAt": { "description": "The date and time at which the instrument was set to `active`.", "format": "date-time", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the instrument.", "readOnly": true, "type": "string" }, "inactiveAt": { "description": "The date and time at which the instrument was set to `inactive`.", "format": "date-time", "readOnly": true, "type": "string" }, "isExternal": { "description": "A payment instrument marked `isExternal=true` is not verified and creates transactions for record purposes only. The `payment.instrument:external` permission is required to set this flag.", "type": "boolean" }, "pendingAt": { "description": "The date and time at which the instrument was set to `pending`.", "format": "date-time", "nullable": true, "type": "string" } }, "type": "object" } ] }, "TransactionFailureReason": { "description": "The transaction failure reason.", "enum": [ "insufficientFunds", "chargeback", "accountClosed", "invalidAccount", "unknownReason", "invalidCvv", "invalidExpirationDate", "avsFailed", "networkError", "cardDeclined", "accountFrozen", "deceased", "invalidRouting", "paymentStopped", "microdepositsFailed", "microdepositsAttemptFailed", "incorrectNumber", "fraudulent", "unauthorizedDebit" ], "type": "string" }, "PaymentInstrumentFailureReasons": { "properties": { "failureDescriptionLong": { "description": "Detailed text describing the failure reason and any appropriate actions the borrower may take to fix the issue.\nNormally displayed in UI.\n", "readOnly": true, "type": "string" }, "failureDescriptionShort": { "description": "Short text describing the failure reason. Normally displayed in UI.\n", "readOnly": true, "type": "string" }, "failureReason": { "$ref": "#/components/schemas/TransactionFailureReason", "description": "A failure code for the most recent transaction failure using this instrument.\n", "nullable": true } }, "type": "object" }, "PaymentInstrumentMutableFields": { "properties": { "externalId": { "description": "A lender's identifier for the instrument.\n\nAfter the object is successfully created, a lender can use ID or externalId identifiers to fetch the object.\n\nTo fetch the object using externalId you need to add `ext-` to the URL.\n\nNote: Don't add ext- to the identifier value. For example: if the external identifier is `ABCDE`, then pass externalId=ACBCE and NOT ext-ABCDE when creating the object.\n", "minLength": 1, "nullable": true, "type": "string" }, "inactiveReason": { "description": "The reason the instrument is inactive. Required when setting status=`inactive`.\n", "enum": [ "fraudAlert", "updated", "notVerified", "expired", "failed", "deleted" ], "type": "string" }, "nickname": { "description": "A nickname for the instrument. The nickname can be displayed in UI.", "type": "string" }, "status": { "default": "pending", "description": "Status of the instrument. Can only be set if `isExternal=true`.\n\nStatuses:\n\n- `active` - the instrument can be charged.\n- `pending` - the instrument is pending to be verified.\n- `inactive` - the instrument is not active and cannot be charged.\n\nWhen updating this field, only the following state transitions are allowed.\n\n```\nactive --> inactive\npending --> active (only for payment instrument with isExternal=true)\npending --> inactive (only for payment instrument with isExternal=true)\ninactive --> active (only for payment instrument with isExternal=true)\ninactive --> pending (only for payment instrument with isExternal=true)\n```\n\nNote: if you update the status from `inactive` to `active` or `pending`,\nthe system will clear the following attributes: `inactiveReason`, `deletedAt`, `failureReason`,\n`failureDescriptionShort`, `failureDescriptionLong`.\n", "enum": [ "active", "inactive", "pending" ], "type": "string" }, "verified": { "default": false, "description": "Indicates whether the instrument has been verified.\n\nUser must have the `payment.instrument:skip.verification` permission to set this value to `true`, or\nthe payment instrument must be marked `isExternal=true`.\n", "type": "boolean" } }, "type": "object" }, "BankAccountImmutableFields": { "properties": { "accountNumberLastFour": { "description": "The last two, three or four digits of the account number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n", "pattern": "^[0-9]{2,4}$", "readOnly": true, "type": "string" }, "instrumentType": { "enum": [ "bankAccount" ], "type": "string" }, "routingNumber": { "description": "The routing number.", "type": "string" } }, "type": "object" }, "AccountLinkError": { "properties": { "errorCodeByVendor": { "description": "The error code as received from the vendor.", "type": "string" }, "errorDescriptionBorrower": { "description": "The error description as received from the vendor for presentation to the borrower.", "type": "string" }, "errorDescriptionInternal": { "description": "The internal error description as received from the vendor.", "type": "string" }, "errorType": { "description": "The error type. This describes the appropriate way to handle the error.", "enum": [ "retry", "relink", "outage" ], "type": "string" }, "errorTypeByVendor": { "description": "The error type as received from the vendor.", "type": "string" } }, "type": "object" }, "AccountLink": { "description": "An object representing a link with a third party vendor (e.g. Plaid) that allows fetching additional account details.", "properties": { "accessToken": { "description": "The vendor's access token for initial access. With Plaid, this can be the `public_token` provided by Plaid Link, or the `access_token` provided after exchanging the public token.", "type": "string" }, "accountId": { "description": "The identifier used to identify an account with the data vendor.", "type": "string" }, "dataServices": { "default": [ "accountInfo" ], "description": "A list of data services available with this link.", "items": { "enum": [ "accountInfo", "balance" ], "type": "string" }, "type": "array" }, "errorCommunicationsSent": { "description": "The number of times the user has been notified that the account link has failed and needs to be recreated.", "readOnly": true, "type": "integer" }, "itemId": { "description": "The vendor's item identifier. With Plaid, this is the `item_id`.", "type": "string" }, "lastErrorCommunicationAt": { "description": "The date and time that the most recent error notification was sent to the user.", "format": "date-time", "readOnly": true, "type": "string" }, "recentError": { "allOf": [ { "description": "The most recent error that occurred while fetching data from this link." }, { "$ref": "#/components/schemas/AccountLinkError" } ] }, "status": { "description": "The status of the account link.", "enum": [ "active", "inactive" ], "type": "string" }, "vendor": { "description": "The data vendor identifier.", "enum": [ "plaid" ], "type": "string" } }, "required": [ "vendor", "accessToken", "accountId" ], "type": "object" }, "BankAccountMutableFields": { "properties": { "accountHolderName": { "description": "For `personal` accounts, the full name of the account holder. For `business` accounts, the business name.\n\nThis is not an account nickname. It should match the name on file for the account with the bank.\n", "type": "string" }, "accountHolderType": { "description": "Type of entity that is the account holder.", "enum": [ "business", "personal" ], "type": "string" }, "accountLink": { "$ref": "#/components/schemas/AccountLink" }, "accountType": { "description": "Type of the account.", "enum": [ "checking", "savings" ], "type": "string" }, "institutionName": { "description": "The name of the financial institution where this account resides. If empty, will default to the name associated\nwith the routing number.\n", "maxLength": 36, "type": "string" } }, "type": "object" }, "BankAccount": { "allOf": [ { "$ref": "#/components/schemas/PaymentInstrumentImmutableFields" }, { "$ref": "#/components/schemas/PaymentInstrumentFailureReasons" }, { "$ref": "#/components/schemas/PaymentInstrumentMutableFields" }, { "$ref": "#/components/schemas/BankAccountImmutableFields" }, { "$ref": "#/components/schemas/BankAccountMutableFields" } ], "required": [ "accountHolderName", "accountHolderType", "accountNumber", "accountType", "instrumentType", "routingNumber" ], "title": "Bank Account" }, "bankAccountAccountNumber": { "properties": { "accountNumber": { "description": "The account number.\nIf `isExternal=true` then the last two, three, or four digits of the account number can be provided.\nProvide four digits if available, otherwise provide two or three digits.\n", "pattern": "^[0-9]+$", "type": "string", "writeOnly": true } }, "required": [ "accountNumber" ], "type": "object" }, "SettlementInstrument": { "allOf": [ { "$ref": "#/components/schemas/BankAccount" }, { "$ref": "#/components/schemas/bankAccountAccountNumber" }, { "properties": { "investorId": { "description": "Public ID of the investor.", "readOnly": true, "type": "string" }, "verified": { "readOnly": true } }, "type": "object" } ] }, "BankAccountMutable": { "allOf": [ { "$ref": "#/components/schemas/PaymentInstrumentMutableFields" }, { "$ref": "#/components/schemas/BankAccountMutableFields" } ], "title": "Bank Account" }, "SettlementInstrumentMutable": { "allOf": [ { "$ref": "#/components/schemas/BankAccountMutable" }, { "type": "object" } ] }, "LoanIdsResponse": { "properties": { "loanIds": { "description": "The list of loans which have the specified label(s) and match the path and query parameters.\n", "items": { "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "LoanIdsRequest": { "properties": { "loanIds": { "description": "The unique identifier of the loans. Can be Peach or lender's external identifier.\n", "items": { "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "LoanTapeFields": { "items": { "enum": [ "reportDate", "investorId", "investorLegalName", "investorOwnershipPercentage", "secondInvestorId", "secondInvestorLegalName", "secondInvestorOwnershipPercentage", "loanId", "loanStatus", "loanExternalId", "loanType", "loanTypeId", "mainBorrowerId", "mainBorrowerExternalId", "currentCreditLimit", "activationDate", "lastDueDate", "effectiveAPR", "interestRate", "indexRate", "promoRate", "interestType", "contractualRecurringAmount", "amountFinanced", "firstDueDateExpectedAmount", "firstDueDatePaymentAmountByDueDate", "upcomingDueDate", "upcomingDueDateExpectedAmount", "outstandingBalanceTotalAmount", "outstandingBalancePrincipalAmount", "outstandingBalanceInterestAmount", "outstandingBalanceFeesAmount", "creditsAppliedTotalAmount", "paymentsMadeTotalAmount", "paymentsMadePrincipalAmount", "paymentsMadeInterestAmount", "paymentsMadeFeesAmount", "paymentsMadeOverAmount", "paymentsMadeReimbursementsAmount", "lastSuccessfulPaymentEffectiveDate", "lastSuccessfulPaymentTotalAmount", "lastSuccessfulPaymentPrincipalAmount", "lastSuccessfulPaymentInterestAmount", "lastSuccessfulPaymentFeesAmount", "isAutopayOn", "recentAutopayAuthorizationDate", "isOverdue", "overdueNumberDays", "overdueBalanceTotalAmount", "overdueBalancePrincipalAmount", "overdueBalanceInterestAmount", "overdueBalanceFeesAmount", "nonDueBalanceTotalAmount", "nonDueBalancePrincipalAmount", "nonDueBalanceInterestAmount", "nonDueBalanceFeesAmount", "dailyInterestAccruedAmount", "dailyInterestDiscountAmount", "dailyForgoneInterestCapAmount", "dueBalanceTotalAmount", "dueBalancePrincipalAmount", "dueBalanceInterestAmount", "dueBalanceFeesAmount", "timesOverdue15Days", "timesOverdue30Days", "timesOverdue60Days", "timesOverdue90Days", "timesOverdue120Days", "isChargedOff", "chargedOffDate", "chargedOffPrincipalAmount", "chargedOffInterestAmount", "chargedOffFeesAmount", "chargedOffTotalAmount", "chargedOffReason", "netInterestAccruedTotalAmount", "interestDiscountTotalAmount", "forgoneInterestCapAmount", "reimbursementAmount", "mainBorrowerFirstName", "mainBorrowerLastName", "mainBorrowerDateOfBirth", "mainBorrowerIdentityType", "mainBorrowerIdentityValue", "mainBorrowerIdentityIssuingCountry", "mainBorrowerIdentityIssueDate", "mainBorrowerIdentityExpirationDate", "mainBorrowerBusinessLegalName", "mainBorrowerBusinessType", "isInSCRAStatus", "activeDutyStartDate", "activeDutyEndDate", "isInBankruptcy", "bankruptcyFiledDate", "bankruptcyCourtCaseNumber", "bankruptcyLastStatus", "bankruptcyDisposition", "bankruptcyChapter", "currentAddressState", "currentAddressPostalCode", "currentAddressLine1", "currentAddressLine2", "currentAddressCity", "currentAddressCountry", "currentEmail", "currentPhone", "refundedAmount", "merchantId", "merchantBusinessName", "originalDuration", "originalPaymentFrequency", "currentPaymentFrequency", "currentRecurringAmount", "paidOffDate", "loanMetaData", "isLoanModified", "principalAmount", "projectedPayoffDate", "remainingDuration", "dataStatus", "overdueOver30DaysBalanceTotalAmount", "overdueOver60DaysBalanceTotalAmount", "overdueOver90DaysBalanceTotalAmount", "overdueOver120DaysBalanceTotalAmount", "overdueOver150DaysBalanceTotalAmount", "overdueOver180DaysBalanceTotalAmount", "nonDueBalanceOriginationFeesAmount", "nonDueBalanceDrawFeesAmount", "nonDueBalanceLateFeesAmount", "nonDueBalanceModificationFeesAmount", "dueBalanceOriginationFeesAmount", "dueBalanceDrawFeesAmount", "dueBalanceLateFeesAmount", "dueBalanceModificationFeesAmount", "originationFeeAmount", "overdueBalanceOriginationFeesAmount", "overdueBalanceDrawFeesAmount", "overdueBalanceLateFeesAmount", "overdueBalanceModificationFeesAmount", "outstandingBalanceOriginationFeesAmount", "outstandingBalanceDrawFeesAmount", "outstandingBalanceLateFeesAmount", "outstandingBalanceModificationFeesAmount", "nonDueBalanceMembershipFeesAmount", "dueBalanceMembershipFeesAmount", "overdueBalanceMembershipFeesAmount", "outstandingBalanceMembershipFeesAmount" ], "type": "string" }, "title": "Loan Tape Fields", "type": "array" }, "PaymentTapeFields": { "items": { "enum": [ "reportDate", "loanId", "loanExternalId", "investorId", "investorLegalName", "investorOwnershipPercentage", "secondInvestorId", "secondInvestorLegalName", "secondInvestorOwnershipPercentage", "transactionId", "transactionExternalId", "status", "effectiveDate", "totalAmount", "principalAmount", "interestAmount", "feesAmount", "unappliedAmount", "paymentMethodType", "processingFeeType", "processingFeeAmount", "isReversal", "isReimbursement", "reversingTransactionId", "reversingTransactionExternalId", "settlementId", "settlementDate" ], "type": "string" }, "title": "Payment Tape Fields", "type": "array" }, "BaseLoanTapeType": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "actionOnMissingData": { "default": "excludeFromTape", "description": "Due to various circumstances, it is possible that not all data needed to produce a given loan tape\nwill be available at the time of tape generation.\n\nIn this situation, there are two options for how these records will be represented in a tape:\n\n- `includeIDsAndEmptyData` (recommended) - The tape will include records that have missing data\n (only `reportDate`, `loanId`, `mainBorrowerId`, `mainBorrowerExternalId`, `loanExternalId`,\n and `dataStatus` columns will be populated, assuming they are configured).\n\n- `excludeFromTape` - Records with missing data will be dropped completely from the tape.\n By choosing `excludeFromTape` lenders will be responsible for validating number of loans included within tapes.\n", "enum": [ "includeIDsAndEmptyData", "excludeFromTape" ], "type": "string" }, "compressionType": { "default": "gzip", "description": "Compression type used for result file.\n", "enum": [ "noCompression", "gzip", "zip" ], "type": "string" }, "fieldNameMappings": { "description": "Mapping of fields from `fields` to field names used in the bank/investor's system.\n\nFor example: `{\"investorId\": \"investor_id\", \"isChargedOff\": \"loan_charged_off\"}`\n", "type": "object" }, "fields": { "anyOf": [ { "$ref": "#/components/schemas/LoanTapeFields" }, { "$ref": "#/components/schemas/PaymentTapeFields" } ], "description": "A list of fields to be included in a specific tape. There are two `tapeType` available - `loans` and `payments`.\nWhen you choose a list of fields, make sure to include only the values corresponding to `tapeType`.\nFor example: `tapeType=loans` cannot have an attribute `paymentMethodType` because that field is only relevant to `tapeType=payments`.\n\n`loanMetaData` - is a special field. If included, the caller must provide the `loanMetaDataFields` attribute.\n\n`mainBorrowerIdentityValue` - is the borrower's identity number such as SSN, ITIN, tax ID, FEIN, etc.\nThis value is encrypted in Peach system. If you want to export that value in loan tapes, you must have `encryptionMethod`\nand `publicKey` set when you call \"Create loan tape\". In other words, loan tape must be encrypted in order to\npopulate `mainBorrowerIdentityValue`.\n" }, "loanMetaDataFields": { "default": [], "description": "A list of loan's `metaData` keys/values to be included in a specific tape.\nLoan's `metaData` attribute consists of key/value pairs in the form of a JSON dictionary.\nThe `loanMetaDataFields` value must be provided if `loanMetaData` is included in the fields list.\nIf the key cannot be found in the loan's `metaData` attribute, the tape will populate the column name\n(aka key) but will not populate the value (aka the value will be empty).\nIf found, each column name will be the \"key\" + \"LoanMetaData\" and the value will be the \"value\".\nThe search/look up of the `loanMetaDataFields` key in the loan's `metaData` attribute is case-sensitive.\nPeach doesn't know what data is provided in the loan's `metaData` attribute, and we don't check validity of the key/value pairs.\nIt's lender/caller responsibility to make sure that the loan's `metaData` attribute has valid and formatted values.\n", "items": { "type": "string" }, "type": "array" }, "moneyUnit": { "default": "subUnit100", "description": "If `subUnit100`, the amount fields in loan tapes will be in pennies. For example: 100 means $1.00 (one dollar).\n\nIf `fullUnit`, the amount fields in loan tapes will be in decimal format with 2 places after the decimal point.\nFor example: 32.45 is thirty-two dollars and forty-five cents.\n", "enum": [ "fullUnit", "subUnit100" ], "type": "string" }, "reportDaysWhenPaidOff": { "default": 10, "description": "Number of days to report a loan after it was changed to `paidOff`.\nMake sure you check that your loan types are configured to generate snapshots for number of days that is greater than reportDaysWhenPaidOff for loans that are in paidOff status.\nIf your company has many loan types, please check them all.\nLoans without snapshots data cannot be reported in the loan tape\n", "minimum": 10, "type": "integer" }, "shouldReportDrawsSeparately": { "default": false, "description": "Indicates whether LOC Draws should be reported as separate rows in loan tape. LOC will always be reported on an aggregated level.\n", "type": "boolean" }, "tapeName": { "description": "A friendly name for the tape.\n", "type": "string" }, "tapeOutputFormat": { "default": "CSV", "description": "The tape output format.", "enum": [ "CSV" ], "type": "string" } }, "type": "object" } ] }, "TapeType": { "allOf": [ { "$ref": "#/components/schemas/BaseLoanTapeType" }, { "properties": { "tapeType": { "description": "The loan tape type.\n\n`loans` - the tape includes information about accounts (e.g. loans).\n\n`payments` - the tape includes information about payments made by borrowers.\n", "enum": [ "loans", "payments" ], "type": "string" } }, "type": "object" } ] }, "LoanTape": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "customFileName": { "description": "If provided, will override the default file name for new loan tape files created.\n[Date and time placeholders](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes) may be used, along with the following placeholders:\n\n- `{{loanTapeId}}` the loan tape ID.\n- `{{loanTapeTypeId}}` the loan tape type ID.\n\nFor example, a value of `loan_tape_{{loanTapeId}}_%m_%d_%Y.csv` might look like `loan_tape_TA-DJEK-CVDE_02_12_2022.csv` when generated.\n", "nullable": true, "type": "string" }, "dateForCustomFileName": { "default": "dateOfGeneration", "description": "Controls the date value for the `customFileName` field. Options:\n\n- `reportDate`: Uses the `reportDate` of the loan tape record\n- `dateOfGeneration`: Uses the date when the loan tape record was generated\n", "enum": [ "reportDate", "dateOfGeneration" ], "nullable": true, "type": "string" }, "encryptionMethod": { "description": "The encryption method that Peach system with use to encrypt the files.\n", "enum": [ "GPG" ], "nullable": true, "type": "string" }, "investorId": { "description": "The investor ID.", "nullable": true, "type": "string" }, "loanTapeTypeId": { "description": "The loan tape type ID.", "type": "string" }, "publicKey": { "description": "The lender's public key to use to encrypt the files. A value must be passed if encryptionMethod is set.", "nullable": true, "type": "string" }, "sftpAccessMethod": { "default": "usernamePassword", "description": "If `usernamePassword`, then `sftpUsername` and `sftpPassword` must be provided.\n\nIf `keys`, then `sftpSSHPeachPrivateKey` and `sftpSSHPeachPublicKey` will be created by peach.\n", "enum": [ "usernamePassword", "keys" ], "type": "string" }, "sftpCdDir": { "description": "Change directory into this folder before performing the upload.\n", "nullable": true, "type": "string" }, "sftpHostname": { "description": "The hostname for SFTP.\nHost name should not contain a scheme, so don't put `sftp://` on the front. You may optionally specify a port like so: `example.com:222`.\nIf no port is supplied a default of 22 will be used.\n", "pattern": "^[^/]+$", "type": "string" }, "sftpPassword": { "description": "The password for SFTP.", "type": "string" }, "sftpSSHPeachPublicKey": { "description": "Peach public key to be used when log into `sftpHostname`.\nThe value can be only be set by the Peach team.\n", "readOnly": true, "type": "string" }, "sftpUsername": { "description": "The username for SFTP.", "type": "string" } }, "type": "object" } ] }, "RepaymentNotificationTrigger": { "description": "A description of the conditions that trigger a communication. NOTE: `autopayExpectedPaymentChangedAmount` will never occur for LOC,\nbecause autopays are finalized after the statement date and not updated again.\n", "enum": [ "autopayFirstPayment", "autopayExpectedPayment", "autopayExpectedPaymentChangedAmount", "cardExpiration", "expectedPayment", "futurePayment", "loginFirstPayment", "loanOverdue", "loanRightToCure", "promoProgramReminder", "promoProgramEligibilityAtRisk" ], "example": "expectedPayment", "readOnly": true, "type": "string" }, "RepaymentEngineInteractionSubject": { "description": "The `InteractionSubject` for the notification that is sent to the borrower.", "enum": [ "autopayAmountChanged", "autopayEnableReminder", "autopayPaymentReminder", "cardExpiresReminder", "futurepayPaymentDueReminder", "loanOverdueFirstNotice", "loanOverdueSecondNotice", "loanOverdueThirdNotice", "loanOverdueFourthNotice", "loanOverdueFifthNotice", "loanOverdueSixthNotice", "loanRightToCurePersonalUnsecured", "loginFirstPaymentReminder", "paymentDueDateReminder", "promoProgramReminder", "promoProgramEligibilityAtRisk" ], "example": "paymentDueDateReminder", "type": "string" }, "ValidInteractionChannel": { "enum": [ "email", "text", "mail" ], "type": "string" }, "DaysOffsetDueDate": { "oneOf": [ { "description": "The number of days offset from the due date that a notification is sent. Should be negative for reminders and positive for\noverdue notices.\n\nWhen `subject=loanRightToCurePersonalUnsecured`, then `loanType.rightToCureBuffer` will be used to\ncompute the offset.\n\nWhen `subject=autopayAmountChanged`, then `loanType.autopay.amountChangeNotificationBuffer` will be used\nto compute the offset.\n\nWhen `subject=promoProgramReminder` or `promoProgramEligibilityAtRisk`, the reminder will trigger `daysOffsetDueDate`\nafter the `PromoProgram` end date, which is why the value should be negative for the reminder and positive for `promoProgramEligibilityAtRisk`.\n", "example": -5, "nullable": true, "type": "integer" }, { "description": "This object controls the exact date on which the loanOverdue reminder is sent. Note that the offsets are absolute.\n", "properties": { "everyTwoWeeks": { "description": "If the notification type has `trigger=loanOverdue` and `isDueDatesAvailableEveryTwoWeeks` is true on this loan type,\nthen this offset will be used for loans with payments that are due every two weeks.\n", "type": "integer" }, "monthly": { "description": "If the notification type has `trigger=loanOverdue` and `isDueDatesAvailableTwiceMonthly` is true on this loan type,\nthen this offset will be used for loans with monthly payments.\n", "type": "integer" }, "singleTerm": { "description": "If the notification type has `trigger=loanOverdue` and `isDueDatesAvailableSingleTerm` is true on this loan type,\nthen this offset will be used for loans with a single term payment.\n", "type": "integer" }, "twiceMonthly": { "description": "If the notification type has `trigger=loanOverdue` and `isDueDatesAvailableTwiceMonthly` is true on this loan type,\nthen this offset will be used for loans with twice monthly payments.\n", "type": "integer" }, "weekly": { "description": "If the notification type has `trigger=loanOverdue` and `isDueDatesAvailableWeekly` is true on this loan type,\nthen this offset will be used for loans with weekly payments.\n", "type": "integer" } }, "type": "object" } ] }, "RepaymentNotificationTypeWithoutSubject": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "companyId": { "description": "The company identifier for this notification type.", "readOnly": true, "type": "string" }, "dayType": { "$ref": "#/components/schemas/DayType" }, "daysOffsetDueDate": { "$ref": "#/components/schemas/DaysOffsetDueDate" }, "loanOverdueWindow": { "description": "**DEPRECATED ATTRIBUTE** Window in which to start sending this notification. Only used for `trigger=loanOverdue`.\n", "properties": { "from": { "description": "Days after the loan is overdue to start sending this notification type.\n", "example": 0, "type": "integer" }, "to": { "description": "Days after the loan is overdue to stop sending this notification type.\n", "example": 30, "type": "integer" } }, "readOnly": true, "required": [ "from", "to" ], "type": "object" }, "loanTypeAssetName": { "type": "string" }, "productId": { "type": "string" }, "promoType": { "description": "Only used for notifications with subject `promoProgramReminder` and `promoProgramEligibilityAtRisk`", "enum": [ "sameAsCash" ], "nullable": true, "type": "string" }, "sendChannels": { "default": [ "email", "text" ], "description": "The channels to send the notification to. By default, the notification is sent to `text` and `email`\nchannels.\n\nThe system always attempts to send to *all* specified channels. As long as at least one contact of the \nspecified channels is available to send to then the notification will considered successful. An error is\nthrown if all three channels are unavailable for the borrower.\n", "items": { "$ref": "#/components/schemas/ValidInteractionChannel" }, "type": "array" }, "status": { "enum": [ "active", "inactive" ], "type": "string" }, "trigger": { "$ref": "#/components/schemas/RepaymentNotificationTrigger" } }, "type": "object" } ] }, "RepaymentNotificationType": { "allOf": [ { "properties": { "subject": { "$ref": "#/components/schemas/RepaymentEngineInteractionSubject" } }, "type": "object" }, { "$ref": "#/components/schemas/RepaymentNotificationTypeWithoutSubject" } ] }, "ResponseEndDate": { "description": "The end date of the promise to pay plan, equal to the `dueDate` of plan's last promise period.\n", "format": "date", "type": "string" }, "ExternalId": { "description": "A lender's identifier for a promise to pay plan.\nAfter the object is successfully created, a lender can use ID or externalId identifiers to fetch the object.\nTo fetch the object using externalId you need to add `ext-` to the URL.\nNote: Don't add ext- to the identifier value. For example: if the external identifier is `ABCDE`, then pass \nexternalId=ACBCE and NOT ext-ABCDE when creating the object.\n", "nullable": true, "type": "string" }, "ResponseStartDate": { "description": "The start date of the promise to pay plan, equal to the `startDate` of plan's first promise period.\n", "format": "date", "type": "string" }, "PromiseToPayPlan": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "cancellationReason": { "description": "The reason for canceling the promise to pay plan.\n\n`canceledByUser` - Promise to pay plan was canceled by an agent or borrower.\n`loanChargedOff` - loan was charged off during the promise period.\n`loanAccelerated` - loan was accelerated during the promise period.\n`otherPromisePlanOffered` - another promise plan was offered.\n`other` - for any other reason requiring cancellation.\n", "enum": [ "canceledByUser", "loanChargedOff", "loanAccelerated", "otherPromisePlanOffered", "other" ], "nullable": true, "type": "string" }, "caseId": { "description": "The ID of the case associated with the promise to pay plan.", "nullable": true, "type": "string" }, "companyId": { "description": "The unique company identifier.", "type": "string" }, "endDate": { "$ref": "#/components/schemas/ResponseEndDate" }, "externalId": { "$ref": "#/components/schemas/ExternalId" }, "id": { "description": "The promise to pay plan ID.", "type": "string" }, "isOverdue": { "description": "The borrower has not met one or more promised amounts by the promised due date.", "type": "boolean" }, "loanId": { "description": "The unique loan identifier that the promise belongs to.", "type": "string" }, "object": { "default": "promiseToPayPlan", "enum": [ "promiseToPayPlan" ], "readOnly": true, "type": "string" }, "reasonDetails": { "description": "Additional details about the reason for canceling the promise to pay plan.", "nullable": true, "type": "string" }, "schedule": { "description": "Promise to pay plan periodId(s) and amount(s).", "items": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "amount": { "description": "Amount of the promise to pay period.", "format": "float", "type": "number" }, "dueDate": { "description": "The due date of the promised amount.", "format": "date", "type": "string" }, "object": { "default": "promisePeriod", "enum": [ "promisePeriod" ], "readOnly": true, "type": "string" }, "periodId": { "description": "Unique identifier of the period created for the promise to pay plan.", "type": "string" }, "startDate": { "description": "The period start date.", "format": "date", "type": "string" } }, "type": "object" } ] }, "type": "array" }, "startDate": { "$ref": "#/components/schemas/ResponseStartDate" }, "status": { "description": "The status of the promise to pay plan. \n\n`scheduled` - promise to pay has been created but has not yet started. Typically used when the lender wants to \nstart a promise as of a specific date. Communications will not be triggered and tasks will not be assigned to \nagents for promise to pay plans in `scheduled` status. Peach's system will transition the status of the promise\nto pay plan to `active` on the `startDate` unless the lender cancels the promise to pay beforehand. \n\n`active` - promise to pay plan is in effect. To check if the borrower is on and behind the schedule, see the `\nisOverdue` attribute.\n\n`kept` - promise to pay final period end date has passed and the borrower has met the promised amount(s) by the \npromise's final period end date. This status is a terminal state.\n\n`broken` - promise to pay final period end date has passed and the borrower has not met the promised amount(s) \nby the promise's final period end date. This status is a terminal state.\n\n`canceled` - promise to pay plan was canceled. This status is a terminal state.\n", "enum": [ "scheduled", "active", "kept", "broken", "canceled" ], "type": "string" } }, "type": "object" } ] }, "Merchant": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "address": { "$ref": "#/components/schemas/AddressBase", "description": "The mailing address." }, "businessName": { "description": "The business name of the merchant. Can be displayed in UI.\n", "type": "string" }, "businessTypeDisplayName": { "description": "The business type/description as shown to borrowers. For\nexample: 'Merchant', 'Dealer', or 'Venue'. Defaults to\n'Merchant' if no value is provided.\n", "type": "string" }, "disputesContactEmail": { "description": "The email of the merchant's disputes department.\n", "maxLength": 320, "type": "string" }, "disputesContactName": { "description": "The name of the merchant's disputes department.\n", "maxLength": 256, "type": "string" }, "disputesContactPhone": { "description": "The phone number of the merchant's disputes department.\n", "maxLength": 15, "type": "string" }, "externalId": { "description": "A lender's identifier for the merchant.\n", "type": "string" }, "parentMerchantId": { "description": "The parent merchant identifier. Used to represent hierarchy of merchant sub entities.\nCan be Peach or lender's external identifier.\n", "nullable": true, "type": "string" }, "primaryContactEmail": { "description": "The email of the merchant's primary contact person or department.\n", "maxLength": 320, "type": "string" }, "primaryContactName": { "description": "The name of the merchant's primary contact person or department.\n", "maxLength": 256, "type": "string" }, "primaryContactPhone": { "description": "The phone number of the merchant's primary contact person or department.\n", "maxLength": 15, "type": "string" }, "subEntityname": { "description": "The sub entity business name of the merchant. For example: Online Sephora.\n", "type": "string" } }, "type": "object" } ] }, "fileName": { "description": "The name of the ACH file.\n", "minLength": 1, "type": "string" }, "AchFileUploadDetails": { "allOf": [ { "properties": { "uploadFailedAt": { "description": "The datetime when the upload of the ACH file failed.\n", "format": "date-time", "nullable": true, "type": "string" }, "uploadNumberOfRetries": { "default": 0, "description": "The number of upload retries for the ACH file.\n", "minimum": 0, "nullable": true, "type": "integer" }, "uploadStartedAt": { "description": "The datetime when the upload of the ACH file began.\n", "format": "date-time", "nullable": true, "type": "string" }, "uploadSucceededAt": { "description": "The datetime when the upload of the ACH file finished successfully.\n", "format": "date-time", "nullable": true, "type": "string" } }, "type": "object" } ] }, "AchFileMutableFields": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "fileName": { "$ref": "#/components/schemas/fileName" }, "gcp": { "allOf": [ { "$ref": "#/components/schemas/AchFileUploadDetails" } ], "description": "GCP Storage upload details" }, "isSettlement": { "default": false, "description": "- If true, the file contains only settlement transactions with investors.\n- If false, the file contains only transactions with borrowers.\n", "type": "boolean" }, "numberOfMicrodeposits": { "default": 0, "description": "The number of microdeposits included in this ACH file.\n", "minimum": 0, "type": "integer" }, "numberOfTransactions": { "default": 0, "description": "The number of transactions included in this ACH file.\n", "minimum": 0, "type": "integer" }, "sftp": { "allOf": [ { "$ref": "#/components/schemas/AchFileUploadDetails" } ], "description": "SFTP Server upload details" } }, "type": "object" } ] }, "AchFile": { "allOf": [ { "type": "object" }, { "$ref": "#/components/schemas/AchFileMutableFields" } ], "required": [ "fileName" ], "title": "ACH File" }, "FundingInstrument": { "allOf": [ { "$ref": "#/components/schemas/BankAccount" }, { "properties": { "verified": { "readOnly": true } }, "type": "object" } ] }, "FundingInstrumentMutable": { "allOf": [ { "$ref": "#/components/schemas/BankAccountMutable" }, { "type": "object" } ] }, "WorkflowStepStatus": { "enum": [ "due", "approved", "rejected", "skipped" ], "type": "string" }, "CaseApprovalConditions": { "description": "Set of steps' statuses that must be met before case outcome can be set\nto approved. Currently, we support \"and\" only between the steps.\n", "items": { "properties": { "stepStatus": { "$ref": "#/components/schemas/WorkflowStepStatus" }, "stepTypeRefId": { "format": "uuid", "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" }, "DecisionQuestionType": { "enum": [ "yesNo", "approveReject" ], "type": "string" }, "StatusChangeHistory": { "description": "The status change history of workflow steps and work items.\n", "items": { "additionalProperties": false, "properties": { "status": { "type": "string" }, "time": { "format": "date-time", "type": "string" }, "user": { "type": "integer" } }, "type": "object" }, "type": "array" }, "StepVisibility": { "enum": [ "normal", "closingApproved", "closingDenied", "closingFalsePositive", "closingNoOutcome" ], "type": "string" }, "WorkflowWorkitemStatus": { "enum": [ "due", "completed", "skipped" ], "type": "string" }, "WorkflowWorkitem": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "descriptionLong": { "nullable": true, "type": "string" }, "descriptionShort": { "type": "string" }, "history": { "$ref": "#/components/schemas/StatusChangeHistory" }, "object": { "default": "workflowWorkitem", "enum": [ "workflowWorkitem" ], "readOnly": true, "type": "string" }, "skippedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "$ref": "#/components/schemas/WorkflowWorkitemStatus" }, "updatedBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user who last updated this work item.\nCan be an agent or automated system process.\n" }, "workflowStepId": { "type": "string" }, "workflowWorkitemTypeId": { "type": "string" } }, "type": "object" } ] }, "WorkflowStep": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "decisionQuestion": { "description": "Decision question that leads to the outcome of the step.\n", "type": "string" }, "decisionQuestionType": { "$ref": "#/components/schemas/DecisionQuestionType" }, "descriptionLong": { "description": "Additional details on how to complete the step.\n", "nullable": true, "type": "string" }, "descriptionShort": { "description": "A short description of the step. Displayed to agents in the UI.\n", "type": "string" }, "history": { "$ref": "#/components/schemas/StatusChangeHistory" }, "mandatory": { "type": "boolean" }, "object": { "default": "workflowStep", "enum": [ "workflowStep" ], "readOnly": true, "type": "string" }, "skippedAt": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "$ref": "#/components/schemas/WorkflowStepStatus" }, "updatedBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user who last updated this workflow step.\nCan be an agent or automated system process.\n" }, "visibility": { "$ref": "#/components/schemas/StepVisibility" }, "workItems": { "description": "List of work items that comprise this workflow step.\n", "items": { "$ref": "#/components/schemas/WorkflowWorkitem" }, "type": "array" }, "workflowId": { "type": "string" }, "workflowStepTypeId": { "type": "string" } }, "type": "object" } ] }, "Workflow": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "approvalConditions": { "$ref": "#/components/schemas/CaseApprovalConditions" }, "completedAt": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "description": "Description of the workflow.", "type": "string" }, "name": { "description": "Short name of the workflow.\n", "type": "string" }, "object": { "default": "workflow", "enum": [ "workflow" ], "readOnly": true, "type": "string" }, "steps": { "description": "List of workflow steps that comprise the workflow.\n", "items": { "$ref": "#/components/schemas/WorkflowStep" }, "type": "array" }, "workflowTypeId": { "type": "string" } }, "type": "object" } ] }, "LoanInvestorsPaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanInvestorsGet" } }, "type": "object" } ] }, "PromoProgramTypeFields": { "properties": { "description": { "description": "A legal description of the promotional program as it should\nbe communicated and shown to borrowers.\nIf the description is provided, borrowers will see the\ndescription in the App / Borrower Portal and/or on\nstatements.\n", "maxLength": 10000, "type": "string" }, "displayName": { "description": "The promotional program name as it is shown to borrowers in\nthe App / Borrower Portal and/or on statements.\n", "type": "string" }, "externalId": { "description": "A lender's unique identifier for a specific promotional\nprogram type.\n", "type": "string" }, "id": { "description": "The promotional program type's unique identifier.", "readOnly": true, "type": "string" }, "metaData": { "description": "Store any type of key/value pairs in the form of a JSON\ndictionary.\n", "nullable": true, "type": "object" }, "status": { "default": "draft", "description": "The promo type status.\nA new type is normally created in the `draft` status.\nWhen you are ready to offer the promotional program type on\nloans, update the status to `active`.\n\nIf the status changes to `deprecated`, the promotional\nprogram cannot be used on new loans.\nLoans in-flight will continue to be eligible to the\ndeprecated promotional program.\n", "enum": [ "draft", "active", "deprecated" ], "type": "string" } }, "type": "object" }, "PromoProgramTypePaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/PromoProgramTypeFields" }, "type": "array" } }, "type": "object" } ] }, "PromoType": { "description": "The promotional program type.\n\n`sameAsCash` - presently only available for installment loans.\n\n`deferredInterest` - presently only available for Lines of\nCredit / Draws.\n", "enum": [ "sameAsCash", "deferredInterest" ], "type": "string" }, "PromoProgramTypePost": { "allOf": [ { "required": [ "promoType", "displayName" ] }, { "properties": { "promoType": { "$ref": "#/components/schemas/PromoType" } }, "type": "object" }, { "$ref": "#/components/schemas/PromoProgramTypeFields" } ], "description": "Create a promo program type" }, "PromoProgramTypePut": { "allOf": [ { "$ref": "#/components/schemas/PromoProgramTypeFields" } ], "description": "Create a promo program type" }, "SupercaseType": { "description": "The different types of supercases.\n\nNote that `supercaseType` is different from `subcaseType`. A `supercaseType` describes\nthe type of the supercase and cannot be changed after supercase creation.\n", "enum": [ "generic", "federalEmergency" ], "type": "string" }, "TaskWorkerPairingConfig": { "properties": { "companyId": { "readOnly": true, "type": "string" }, "createdAt": { "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "deletedAt": { "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "externalId": { "nullable": true, "type": "string" }, "id": { "readOnly": true, "type": "string" }, "isDefault": { "description": "If `true` this pairing config is the default for the company. Only one pairing config\ncan be the default at a time.\n", "readOnly": true, "type": "boolean" }, "name": { "description": "A human-readable name for this pairing config.\n", "type": "string" }, "object": { "readOnly": true, "type": "string" }, "overrideTwilioTaskWorkflowExpression": { "description": "If the characteristics of the tasks you wish to match cannot be fully described by the \n`taskMatch` object, you can override the Twilio \"TaskRouter expression\" used\nto match the workers by settings this field. (In which case you will see the\nvalue set here in the field `twilioTaskWorkflowExpression` as well.)\n\nThis field's syntax must conform to the Twilio \"TaskRouter Expression\" syntax[1].\n\nSince this syntax is not validated here, it may be difficult to debug invalid\nexpressions; as such, it is recommended you use the `taskMatch` object when possible.\n\nSome useful expression examples for TaskRouter task attributes:\n \n- Matching a task with an email interaction which was sent to the email\n address `support@loans.acme.com`.\n `interaction.channel = \"email\" AND \"support@loans.acme.com\" IN interactionMeta.recipients.emails`\n- Matching an inbound phone call to a particular support phone number `+15555555555`: \n `interaction.channel = \"voice\" AND interactionMeta.to.phone = \"+15555555555\"`\n\n[1] https://www.twilio.com/docs/taskrouter/expression-syntax\n", "type": "string" }, "overrideTwilioWorkerQueueExpression": { "description": "If the characteristics of the workers you wish to match cannot be fully described by the \n`workerMatch` object, you can override the Twilio \"TaskRouter expression\" used\nto match the workers by settings this field. (In which case you will see the\nvalue set here in the field `twilioWorkerQueueExpression` as well.)\n\nThis field's syntax must conform to the Twilio \"TaskRouter Expression\" syntax[1].\n\nSince this syntax is not validated here, it may be difficult to debug invalid\nexpressions; as such, it is recommended you use the `workerMatch` object when possible.\n\n[1] https://www.twilio.com/docs/taskrouter/expression-syntax\n", "type": "string" }, "priority": { "description": "The order in which this pairing config should be evaluated. Higher numbers are evaluated first.\n\nNote that the default pairing config is always evaluated LAST (and it's `priority` is always `null`.)\n", "nullable": true, "type": "integer" }, "taskMatch": { "properties": { "case": { "properties": { "autocreated": { "description": "If `true` only match tasks with autocreated cases. If `false` match not-autocreated cases. If `null` match any.\n", "nullable": true, "type": "boolean" }, "caseTypeEnums": { "description": "List of `caseType`; match any task with a case with a case type matching in the list.\nNote this field is different from `caseTypeIds`, which matches on specific case type instance rather than the case type enum. If `null` match any case.\n", "items": { "$ref": "#/components/schemas/BaseCaseType" }, "nullable": true, "type": "array" }, "caseTypeIds": { "description": "List of case type IDs; match any task with a case with a case type present in the list.\nNote this field is different from `caseTypeEnums`, which matches on case type enum rather than a specific case type instance. If `null` match any.\n", "items": { "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "interaction": { "properties": { "channels": { "description": "List of `interactionChannel`. Match any task with an `interaction` which has an `channel` present in the list. If `null` match any.\n", "items": { "$ref": "#/components/schemas/InteractionChannel" }, "nullable": true, "type": "array" }, "directions": { "description": "List of `interactionDirections`. Match any task with an `interaction` which has an `direction` present in the list. If `null` match any.\n", "items": { "$ref": "#/components/schemas/InteractionDirection" }, "nullable": true, "type": "array" }, "subjects": { "description": "List of `interactionSubject`. Match any task with an `interaction` which has an `subject` present in the list. If `null` match any.\n", "items": { "$ref": "#/components/schemas/InteractionSubject" }, "nullable": true, "type": "array" }, "themes": { "description": "List of `interactionTheme`. Match any task with an `interaction` which has an `theme` present in the list. If `null` match any.\n", "items": { "$ref": "#/components/schemas/InteractionTheme" }, "nullable": true, "type": "array" } }, "type": "object" }, "not": { "description": "If `true` then match tasks NOT matching those specified in this `taskMatch` object.\n\n(Look in the `twilioWorkerQueueExpression` to see each individual expression clause\n`NOT`-ed when this is set.)\n", "nullable": true, "type": "boolean" }, "supercase": { "properties": { "supercaseTypeEnums": { "description": "List of `supercaseType`; match any task with a supercase with a supercase type matching in the list.\nIf `null` match any task.\n", "items": { "$ref": "#/components/schemas/SupercaseType" }, "nullable": true, "type": "array" } }, "type": "object" }, "taskTypes": { "items": { "$ref": "#/components/schemas/TaskType" }, "nullable": true, "type": "array" } }, "type": "object" }, "twilioTaskWorkflowExpression": { "description": "The Twilio \"TaskRouter Expression\" string used to match tasks.\n\nThis field is read-only because it's generated by configuring\nthe `taskMatch` object, or it's set via the `overrideTwilioTaskWorkflowExpression`\nfield.\n", "readOnly": true, "type": "string" }, "twilioWorkerQueueExpression": { "description": "The Twilio \"TaskRouter expression\" string used to match workers.\n\nThis field is read-only because it's generated by configuring\nthe `workerMatch` object, or it is set via the `overrideTwilioWorkerQueueExpression`\nfield.\n", "readOnly": true, "type": "string" }, "updatedAt": { "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "workerMatch": { "description": "An object describing the characteristics of the workers to match to the tasks \nmatched in `taskMatch`.\n\nThe settings here are translated into Twilio \"expression syntax\"[1] and matched against\nthe workers' attributes. You can see the generated expression in the field \n`twilioWorkerQueueExpression`.\n\n[1] https://www.twilio.com/docs/taskrouter/expression-syntax\n", "properties": { "isManager": { "description": "If `true` match only manager employees. If `false` match only non-manager employees. If `null`\nmatch any.\n", "nullable": true, "type": "boolean" }, "roleIds": { "description": "List of role IDs; match any employee which belongs to at least one of these roles. If `null` match any.\n", "items": { "type": "string" }, "nullable": true, "type": "array" }, "teamIds": { "description": "List of team IDs; match any employee which belongs to at least one of these teams. If `null` match any.\n", "items": { "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" } }, "type": "object" }, "TaskWorkerPairingConfigPaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/TaskWorkerPairingConfig" }, "type": "array" } }, "type": "object" } ] }, "QueueWaitSplitInnerStatistics": { "properties": { "above": { "properties": { "reversations_accepted": { "type": "number" }, "tasks_canceled": { "type": "number" } }, "type": "object" }, "below": { "properties": { "reversations_accepted": { "type": "number" }, "tasks_canceled": { "type": "number" } }, "type": "object" } }, "type": "object" }, "QueueWaitSplitStatistics": { "nullable": true, "properties": { "5": { "$ref": "#/components/schemas/QueueWaitSplitInnerStatistics" }, "10": { "$ref": "#/components/schemas/QueueWaitSplitInnerStatistics" } }, "type": "object" }, "QueueWaitDurationStatistics": { "properties": { "avg": { "type": "number" }, "max": { "type": "number" }, "min": { "type": "number" }, "total": { "type": "number" } }, "type": "object" }, "QueueActivityStatistics": { "properties": { "friendly_name": { "type": "string" }, "sid": { "type": "string" }, "workers": { "type": "integer" } }, "type": "object" }, "TaskQueueData": { "properties": { "account_sid": { "type": "string" }, "assignment_activity_name": { "nullable": true, "type": "string" }, "assignment_activity_sid": { "nullable": true, "type": "string" }, "cumulative_statistics": { "properties": { "avg_task_acceptance_time": { "type": "number" }, "end_time": { "format": "date-time", "type": "string" }, "reservations_accepted": { "type": "integer" }, "reservations_canceled": { "type": "integer" }, "reservations_created": { "type": "integer" }, "reservations_rejected": { "type": "integer" }, "reservations_rescinded": { "type": "integer" }, "reservations_timed_out": { "type": "integer" }, "split_by_wait_time": { "$ref": "#/components/schemas/QueueWaitSplitStatistics" }, "start_time": { "format": "date-time", "type": "string" }, "tasks_canceled": { "type": "integer" }, "tasks_completed": { "type": "integer" }, "tasks_deleted": { "type": "integer" }, "tasks_entered": { "type": "integer" }, "tasks_moved": { "type": "integer" }, "wait_duration_in_queue_until_accepted": { "$ref": "#/components/schemas/QueueWaitDurationStatistics" }, "wait_duration_until_accepted": { "$ref": "#/components/schemas/QueueWaitDurationStatistics" }, "wait_duration_until_canceled": { "$ref": "#/components/schemas/QueueWaitDurationStatistics" } }, "type": "object" }, "date_created": { "format": "date-time", "type": "string" }, "date_updated": { "format": "date-time", "type": "string" }, "friendly_name": { "type": "string" }, "max_reserved_workers": { "type": "integer" }, "real_time_statistics": { "properties": { "activity_statistics": { "items": { "$ref": "#/components/schemas/QueueActivityStatistics" }, "type": "array" }, "longest_relative_task_age_in_queue": { "type": "integer" }, "longest_relative_task_sid_in_queue": { "nullable": true, "type": "string" }, "longest_task_waiting_age": { "type": "integer" }, "longest_task_waiting_sid": { "nullable": true, "type": "string" }, "tasks_by_priority": { "type": "object" }, "tasks_by_status": { "properties": { "assigned": { "type": "integer" }, "canceled": { "type": "integer" }, "pending": { "type": "integer" }, "reserved": { "type": "integer" }, "wrapping": { "type": "integer" } }, "type": "object" }, "total_available_workers": { "type": "integer" }, "total_eligible_workers": { "type": "integer" }, "total_tasks": { "type": "integer" } }, "type": "object" }, "reservation_activity_name": { "nullable": true, "type": "string" }, "reservation_activity_sid": { "nullable": true, "type": "string" }, "sid": { "nullable": true, "type": "string" }, "target_workers": { "nullable": true, "type": "string" }, "task_order": { "type": "string" }, "workspace_sid": { "type": "string" } }, "type": "object" }, "TaskAssignmentStatus": { "enum": [ "pending", "reserved", "assigned", "wrapping", "completed", "canceled" ], "type": "string" }, "TaskAttributesBase": { "description": "The attributes of the task. These are the \"content\" of the task, which describe\nthe work to be done.\n", "properties": { "task_init_at": { "description": "The date and time the original task was created. This is the time the original task was created, not \nthe time the task was re-created, if it was re-created.\n", "type": "string" }, "task_lifelong_id": { "description": "A unique identifier for the task that is guaranteed to be the same over the lifetime of the task\nevent if the task is re-created via the \"Unable To Complete\" functionality.\n", "type": "string" } }, "type": "object" }, "LoanTypesForTask": { "items": { "properties": { "ids": { "example": [ "LT-AAAA-BBBB" ], "items": { "type": "string" }, "type": "array" }, "names": { "example": [ "Foobar Installment Loan" ], "items": { "type": "string" }, "type": "array" }, "types": { "items": { "enum": [ "installment", "lineOfCredit" ], "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "BorrowerForTask": { "description": "The metadata of the borrower about which this task is the subject.\n", "properties": { "id": { "description": "The unique identifier for the borrower.\n", "example": "BO-AAAA-BBBB", "type": "string" }, "loanTypes": { "$ref": "#/components/schemas/LoanTypesForTask", "description": "Type information about ALL the loans associated with this borrower.\n" }, "name": { "description": "The full name of the borrower.\n", "type": "string" } }, "type": "object" }, "TwilioMinimalInteraction": { "allOf": [ { "$ref": "#/components/schemas/BaseTwilioMinimalInteraction" }, { "properties": { "previousInteractionSubject": { "$ref": "#/components/schemas/InteractionSubject" }, "previousInteractionTheme": { "$ref": "#/components/schemas/InteractionTheme" } }, "type": "object" } ] }, "TaskAttributesAnswerInboundVoiceCall": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "account_sid": { "type": "string" }, "api_version": { "type": "string" }, "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "call_sid": { "type": "string" }, "called": { "type": "string" }, "called_city": { "type": "string" }, "called_country": { "type": "string" }, "called_state": { "type": "string" }, "called_zip": { "type": "string" }, "caller": { "type": "string" }, "caller_city": { "type": "string" }, "caller_country": { "type": "string" }, "caller_state": { "type": "string" }, "caller_zip": { "type": "string" }, "case": { "description": "Always `null`", "nullable": true, "type": "object" }, "direction": { "type": "string" }, "from": { "type": "string" }, "from_city": { "type": "string" }, "from_country": { "type": "string" }, "from_state": { "type": "string" }, "from_zip": { "type": "string" }, "interaction": { "$ref": "#/components/schemas/TwilioMinimalInteraction" }, "task_type": { "enum": [ "answerInboundVoiceCall" ], "type": "string" }, "to": { "type": "string" }, "to_city": { "type": "string" }, "to_country": { "type": "string" }, "to_state": { "type": "string" }, "to_zip": { "type": "string" } }, "type": "object" } ] }, "CaseForTask": { "description": "The case object associated with this task.\n\nNote that this represents the case data at the moment the task was published,\nif subsequent changes have been made to the case, they will not be reflected here.\n", "properties": { "autoCreated": { "type": "boolean" }, "borrowerIds": { "items": { "type": "string" }, "type": "array" }, "caseType": { "$ref": "#/components/schemas/BaseCaseType" }, "caseTypeMeta": { "description": "Metadata about the case type object.\n", "properties": { "base": { "type": "string" }, "derivedFromTypeId": { "nullable": true, "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" }, "companyId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "escalatedEmployeeId": { "nullable": true, "type": "string" }, "escalatedTeamId": { "description": "The ID of the team to which this case is escalated.", "nullable": true, "type": "string" }, "escalationIsUrgent": { "description": "If `true` then the case is considered \"urgent\" and should be handled with priority.\n", "nullable": true, "type": "boolean" }, "id": { "description": "ID of the case.", "type": "string" }, "loanTypes": { "$ref": "#/components/schemas/LoanTypesForTask", "description": "Type information about just the loans associated with this case.\n", "nullable": true }, "name": { "type": "string" }, "outcome": { "$ref": "#/components/schemas/ProcessOutcome" }, "owningUserId": { "nullable": true, "type": "string" }, "people": { "items": { "type": "string" }, "type": "array" }, "relatedLoansSummary": { "properties": { "isAnyOverdue": { "type": "boolean" }, "maxDaysOverdue": { "type": "integer" }, "totalOverdueAmount": { "type": "integer" } }, "type": "object" }, "status": { "type": "string" }, "typeId": { "description": "ID of the case type.", "type": "string" } }, "type": "object" }, "TaskAttributesHandleInboundInteraction": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "$ref": "#/components/schemas/BorrowerForTask" }, "case": { "$ref": "#/components/schemas/CaseForTask", "nullable": true }, "interaction": { "$ref": "#/components/schemas/TwilioMinimalInteraction" }, "task_type": { "enum": [ "handleInboundInteraction" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesHandleUnboundInboundInteraction": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "description": "Always `null`", "nullable": true, "type": "object" }, "case": { "$ref": "#/components/schemas/CaseForTask", "nullable": true }, "interaction": { "$ref": "#/components/schemas/TwilioMinimalInteraction" }, "task_type": { "enum": [ "handleUnboundInboundInteraction" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesMakeScheduledCall": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "$ref": "#/components/schemas/BorrowerForTask" }, "case": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/CaseForTask" } ] }, "interaction": { "$ref": "#/components/schemas/TwilioMinimalInteraction" }, "task_type": { "enum": [ "makeScheduledCall" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReplyToNewText": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "case": { "description": "Always `null`", "nullable": true, "type": "object" }, "interaction": { "$ref": "#/components/schemas/TwilioMinimalInteraction" }, "task_type": { "enum": [ "replyToNewText" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReplyToNewWebChat": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "$ref": "#/components/schemas/BorrowerForTask" }, "case": { "description": "Always `null`", "nullable": true, "type": "object" }, "interaction": { "$ref": "#/components/schemas/TwilioMinimalInteraction" }, "task_type": { "enum": [ "replyToNewWebChat" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReplyToAbandonedWebChat": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "$ref": "#/components/schemas/BorrowerForTask" }, "case": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/CaseForTask" } ] }, "interaction": { "$ref": "#/components/schemas/TwilioMinimalInteraction" }, "task_type": { "enum": [ "replyToAbandonedWebChat" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReviewEscalatedCaseAgent": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "case": { "$ref": "#/components/schemas/CaseForTask" }, "interaction": { "description": "Always `null`", "nullable": true, "type": "object" }, "task_type": { "enum": [ "reviewEscalatedCaseAgent" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReviewEscalatedCaseAgentUrgent": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "case": { "$ref": "#/components/schemas/CaseForTask" }, "interaction": { "description": "Always `null`", "nullable": true, "type": "object" }, "task_type": { "enum": [ "reviewEscalatedCaseAgentUrgent" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReviewEscalatedCaseTeam": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "case": { "$ref": "#/components/schemas/CaseForTask" }, "interaction": { "description": "Always `null`", "nullable": true, "type": "object" }, "task_type": { "enum": [ "reviewEscalatedCaseTeam" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReviewEscalatedCaseTeamUrgent": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "case": { "$ref": "#/components/schemas/CaseForTask" }, "interaction": { "description": "Always `null`", "nullable": true, "type": "object" }, "task_type": { "enum": [ "reviewEscalatedCaseTeamUrgent" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReviewDocumentUpload": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "$ref": "#/components/schemas/BorrowerForTask" }, "case": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/CaseForTask" } ] }, "interaction": { "description": "Always `null`", "nullable": true, "type": "object" }, "task_type": { "enum": [ "reviewDocumentUpload" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReviewSnoozedCase": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "case": { "$ref": "#/components/schemas/CaseForTask" }, "interaction": { "description": "Always `null`", "nullable": true, "type": "object" }, "task_type": { "enum": [ "reviewSnoozedCase" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReviewAutoCreatedCase": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "case": { "$ref": "#/components/schemas/CaseForTask" }, "interaction": { "description": "Always `null`", "nullable": true, "type": "object" }, "task_type": { "enum": [ "reviewAutoCreatedCase" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReviewAutoUpdatedCase": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "case": { "$ref": "#/components/schemas/CaseForTask" }, "interaction": { "description": "Always `null`", "nullable": true, "type": "object" }, "task_type": { "enum": [ "reviewAutoUpdatedCase" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReviewCaseInstructions": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "case": { "$ref": "#/components/schemas/CaseForTask" }, "interaction": { "description": "Always `null`", "nullable": true, "type": "object" }, "task_type": { "enum": [ "reviewCaseInstructions" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesReviewVoicemail": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "case": { "description": "Always `null`", "nullable": true, "type": "object" }, "interaction": { "$ref": "#/components/schemas/TwilioMinimalInteraction" }, "task_type": { "enum": [ "reviewVoicemail" ], "type": "string" } }, "type": "object" } ] }, "TaskAttributesSmartReviewCase": { "allOf": [ { "$ref": "#/components/schemas/TaskAttributesBase" }, { "properties": { "borrower": { "allOf": [ { "nullable": true, "type": "object" }, { "$ref": "#/components/schemas/BorrowerForTask" } ] }, "case": { "$ref": "#/components/schemas/CaseForTask" }, "interaction": { "description": "Always `null`", "nullable": true, "type": "object" }, "task_type": { "enum": [ "smartReviewCase" ], "type": "string" } }, "type": "object" } ] }, "Task": { "properties": { "account_sid": { "description": "The unique identifier for the Twilio account.", "type": "string" }, "addons": { "description": "Currently unused.", "type": "string" }, "age": { "description": "Time since this task was created in seconds.\n", "type": "integer" }, "assignment_status": { "$ref": "#/components/schemas/TaskAssignmentStatus" }, "attributes": { "oneOf": [ { "$ref": "#/components/schemas/TaskAttributesAnswerInboundVoiceCall" }, { "$ref": "#/components/schemas/TaskAttributesHandleInboundInteraction" }, { "$ref": "#/components/schemas/TaskAttributesHandleUnboundInboundInteraction" }, { "$ref": "#/components/schemas/TaskAttributesMakeScheduledCall" }, { "$ref": "#/components/schemas/TaskAttributesReplyToNewText" }, { "$ref": "#/components/schemas/TaskAttributesReplyToNewWebChat" }, { "$ref": "#/components/schemas/TaskAttributesReplyToAbandonedWebChat" }, { "$ref": "#/components/schemas/TaskAttributesReviewEscalatedCaseAgent" }, { "$ref": "#/components/schemas/TaskAttributesReviewEscalatedCaseAgentUrgent" }, { "$ref": "#/components/schemas/TaskAttributesReviewEscalatedCaseTeam" }, { "$ref": "#/components/schemas/TaskAttributesReviewEscalatedCaseTeamUrgent" }, { "$ref": "#/components/schemas/TaskAttributesReviewDocumentUpload" }, { "$ref": "#/components/schemas/TaskAttributesReviewSnoozedCase" }, { "$ref": "#/components/schemas/TaskAttributesReviewAutoCreatedCase" }, { "$ref": "#/components/schemas/TaskAttributesReviewAutoUpdatedCase" }, { "$ref": "#/components/schemas/TaskAttributesReviewCaseInstructions" }, { "$ref": "#/components/schemas/TaskAttributesReviewVoicemail" }, { "$ref": "#/components/schemas/TaskAttributesSmartReviewCase" } ] }, "date_created": { "description": "The date and time the task was created. (Potentially this differs from the `task_init_at` field in \nthe task's attributes, since when a task is re-created via the \"Unable To Complete\" functionality, \nthis value will be the time the task was re-created.)\n", "format": "date-time", "type": "string" }, "date_updated": { "format": "date-time", "type": "string" }, "priority": { "description": "The priority of the task. A higher priority task jumps the queue ahead of lower priority tasks.\nBy default, tasks have a priority of 0. For example, inbound texts and chats may be configured\nto have a higher priority. And usually, calls will have an even higher priority.\n", "type": "integer" }, "reason": { "description": "Reason for task cancellation or completion, if applicable.", "nullable": true, "type": "string" }, "reservation": { "nullable": true, "type": "string" }, "sid": { "description": "The unique identifier for the task.", "type": "string" }, "task_channel_sid": { "description": "The SID of the channel this task is associated with.", "type": "string" }, "task_channel_unique_name": { "description": "The unique name of the channel this task is associated with.", "type": "string" }, "task_queue_entered_date": { "description": "The date and time the task entered the queue.", "format": "date-time", "type": "string" }, "task_queue_friendly_name": { "description": "A human-readable name for the task queue.", "type": "string" }, "task_queue_sid": { "description": "The SID of the queue this task is associated with.", "type": "string" }, "timeout": { "description": "The timeout value in seconds for task assignment. After this time, the task will be reassigned\nto another agent.\n", "type": "integer" }, "workflow_friendly_name": { "description": "A human-readable name for the workflow.", "type": "string" }, "workflow_sid": { "description": "The SID of the workflow this task is associated with.", "type": "string" }, "workspace_sid": { "description": "The SID of the workspace this task belongs to.", "type": "string" } }, "type": "object" }, "VersionStatus": { "enum": [ "draft", "active", "deprecated" ], "type": "string" }, "WorkflowStepType": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "additionalProperties": false, "properties": { "companyId": { "description": "The company identifier.", "readOnly": true, "type": "string" }, "createdBy": { "description": "User identifier who created the workflow step type.", "readOnly": true, "type": "string" }, "decisionQuestion": { "description": "Decision question is what leads to the \"accepted\" or \"rejected\" outcome\nof the step. This question is displayed to an agent next to the outcome\nof the step. The questions can lead to accept/reject or to yes/no answers.\n", "type": "string" }, "decisionQuestionType": { "$ref": "#/components/schemas/DecisionQuestionType" }, "descriptionLong": { "description": "Additional details on how to complete the step. Normally displayed\nto an agent when clicked on \"more info\" or \"?\" or \"i\" icons.\n", "nullable": true, "type": "string" }, "descriptionShort": { "description": "A short description of the step. Displayed to agents in the UI.\nCan be a sentence.\n", "type": "string" }, "mandatory": { "type": "boolean" }, "refId": { "description": "The globally unique identifier of the workflow step type.", "format": "uuid", "type": "string" }, "updatedBy": { "description": "User identifier who last updated the workflow step type.", "readOnly": true, "type": "string" }, "version": { "description": "Version of the workflow step type.", "type": "integer" }, "versionStatus": { "$ref": "#/components/schemas/VersionStatus" }, "visibility": { "$ref": "#/components/schemas/StepVisibility" }, "workItems": { "description": "List of work item types that comprise this workflow step type.\n", "items": { "description": "Work item type ID.", "type": "string" }, "type": "array" } }, "type": "object" } ] }, "WorkflowType": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "additionalProperties": false, "properties": { "approvalConditions": { "$ref": "#/components/schemas/CaseApprovalConditions" }, "companyId": { "description": "The company identifier.", "readOnly": true, "type": "string" }, "createdBy": { "description": "User identifier who created the workflow type.", "readOnly": true, "type": "string" }, "description": { "description": "Description of the workflow type. Used internally.", "type": "string" }, "name": { "description": "A short name of workflow. For example: bankruptcy or identity theft.\n", "type": "string" }, "refId": { "description": "The globally unique identifier of the workflow type.", "format": "uuid", "type": "string" }, "steps": { "description": "List of step types that comprise a workflow of this type.\n", "items": { "description": "Step type ID.", "type": "string" }, "type": "array" }, "updatedBy": { "description": "User identifier who last updated the workflow type.", "readOnly": true, "type": "string" }, "version": { "description": "Version of the workflow type.", "type": "integer" }, "versionStatus": { "$ref": "#/components/schemas/VersionStatus" } }, "type": "object" } ] }, "WorkflowWorkitemType": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "additionalProperties": false, "properties": { "companyId": { "description": "The company identifier.", "readOnly": true, "type": "string" }, "createdBy": { "description": "User identifier who created the workflow item type.", "readOnly": true, "type": "string" }, "descriptionLong": { "description": "Additional information required to complete the work item.\n", "nullable": true, "type": "string" }, "descriptionShort": { "description": "A short description of the work item. Displayed to agents in the UI.\nCan be a sentence.\n", "type": "string" }, "refId": { "description": "The globally unique identifier of the workflow workitem type.", "format": "uuid", "type": "string" }, "updatedBy": { "description": "User identifier who last updated the workflow item type.", "readOnly": true, "type": "string" }, "version": { "description": "Version of the work item type.", "type": "integer" }, "versionStatus": { "$ref": "#/components/schemas/VersionStatus" } }, "type": "object" } ] }, "Code": { "allOf": [ { "$ref": "#/components/schemas/VersionedMixin" }, { "properties": { "code": { "description": "Base64 of the compiled binary code", "nullable": true, "readOnly": true, "type": "string" }, "codeText": { "description": "The source code to compile", "type": "string" }, "compilationVersion": { "description": "The compile version", "maxLength": 20, "nullable": true, "readOnly": true, "type": "string" }, "lastCompiledAt": { "description": "Timestamp of last compile", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "name": { "description": "The name of the code", "type": "string" } }, "type": "object" } ], "title": "code" }, "CodePaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Code" }, "type": "array" } }, "type": "object" } ], "title": "code" }, "CodeExecution": { "description": "Execution of code requires that all arguments to the function be submitted as key-value pairs.\nRunning compiled code will produce a single value output.\n", "properties": { "parameters": { "type": "object", "writeOnly": true }, "result": { "readOnly": true } }, "type": "object" }, "DoNotInteractChannel": { "description": "Channel(s) for which outbound interactions with a borrower are blocked. Use value `all`\nfor all channels. At least one of the attributes, `channel` or `theme`,\nmust be provided.\n", "enum": [ "all", "voice", "email", "fax", "text", "chat", "mail" ], "type": "string" }, "onCondition": { "description": "Array of conditions for case fields values. `and` operator is used if multiple conditions\nare provided. For example:\n- A `bankruptcy` case has two fields, `chapter` and `dispositionCode`.\n- If two conditions are created: first `chapter=chapter17`, second `dispositionCode=dismissed`.\n- The logical condition will look like: `chapter=chapter17` **and** `dispositionCode=dismissed`.\n", "items": { "properties": { "dataType": { "$ref": "#/components/schemas/DataType" }, "fieldName": { "$ref": "#/components/schemas/FieldName" }, "operator": { "default": "eq", "description": "The value of the case `fieldName` is compared to `value` using this logical operator.\nFor example, bankruptcy case `fieldName=chapter` can be compared with `value=dismissed` using `eq` (equal operator).\n\n`eq`=equal, `gt`=greater than, `ge`=greater or equal, `lt`=less than, `le`=less or equal, `ne`=not equal.\n", "enum": [ "eq", "gt", "ge", "lt", "le", "ne" ], "type": "string" }, "value": { "description": "The value to compare with.\n" } }, "type": "object" }, "nullable": true, "type": "array" }, "DoNotInteractTheme": { "description": "Theme(s) for which outbound interactions with a borrower are blocked. Use value\n`all` for all themes. `all` doesn't include `opsAccountCredentials`.\nFor example, use `opsCollDebt` to stop debt collection interactions.\nAt least one of the attributes, `channel` or `theme`, must be provided.\n", "enum": [ "all", "opsCollDebt", "opsCollLocateBorrower", "opsCollVerifyEmployment", "opsCollContactEmployerNotice", "opsServicingDebtValidation", "opsServicingNegativeCreditReportNotice", "opsServicingTimeBarredNotice", "opsServicing" ], "type": "string" }, "DoNotInteractType": { "allOf": [ { "$ref": "#/components/schemas/VersionedMixin" }, { "properties": { "channel": { "$ref": "#/components/schemas/DoNotInteractChannel", "description": "Channel(s) for which outbound interactions with a borrower are blocked.\nUse value `all` for all channels.\n" }, "duration": { "default": 0, "description": "Number of days during which the interactions will be blocked.\nWe start counting from the day conditions are met.\n", "minimum": 0, "nullable": true, "type": "integer" }, "object": { "default": "doNotInteractType", "enum": [ "doNotInteractType" ], "readOnly": true, "type": "string" }, "onCondition": { "$ref": "#/components/schemas/onCondition" }, "onOutcome": { "$ref": "#/components/schemas/ProcessOutcome" }, "onStatus": { "$ref": "#/components/schemas/ProcessStatus" }, "theme": { "$ref": "#/components/schemas/DoNotInteractTheme", "description": "Theme(s) for which outbound interactions with a borrower are blocked. Use value\n`all` for all themes. `all` doesn't include `opsAccountCredentials`.\nFor example, use `opsCollDebt` to stop debt collection interactions.\n" }, "unit": { "description": "Indicates how to count days provided in `duration`.", "enum": [ "calendarDays", "businessDays" ], "nullable": true, "type": "string" } }, "type": "object" } ], "title": "doNotInteractHandler" }, "DocumentStatus": { "description": "The document status. The status can be displayed in UI.\n\n`draft` - the document was rendered or created but has not accepted or rejected yet.\n\n`accepted` - the document was determined to be valid and was accepted.\n\n`rejected` - the document was determined to be invalid and was rejected.\n", "enum": [ "draft", "accepted", "rejected" ], "type": "string" }, "DocumentDescriptorFields": { "properties": { "archived": { "default": false, "description": "Set to `true` if the document has been archived.\n", "type": "boolean" }, "autogenerated": { "description": "`true` if this document is generated automatically by a Peach system, `false` if this\ndocument is created and uploaded manually by a human. If left blank then this value is\nguessed from the document type.\n", "nullable": true, "type": "boolean" }, "contentId": { "description": "The document content identifier. Use this identifier to get the document content.", "format": "uuid", "readOnly": true, "type": "string" }, "contentLength": { "description": "The document content length in bytes.", "minimum": 0, "readOnly": true, "type": "integer" }, "contentType": { "description": "The document content type. For example, PDF or JPEG.", "readOnly": true, "type": "string" }, "conversionSourceId": { "description": "The original document identifier that was used as a source for conversion to a specific format.", "readOnly": true, "type": "string" }, "description": { "description": "The description for the document. Normally displayed in UI.", "type": "string" }, "evidenceId": { "description": "The evidence document identifier. For example: when a borrower enables Autopay, the evidence\ndocument will be the snapshot of UI page.\n", "nullable": true, "type": "string" }, "fileName": { "description": "The file name of the document. If the document is rendered from a template by the Peach system,\nthe file name will be generated automatically.\nIf the document is created from a file, it will be the name of the file that was uploaded.\nNormally displayed in UI.\n", "type": "string" }, "isHumanBorrowerUpload": { "description": "`true` if this document was uploaded by a human borrower--meaning that a borrower (or\ntheir representative) used a browser to upload this document directly. To put this\nanother way, this document was *not* uploaded by an agent and was *not* uploaded by any\nautomated system.\n", "readOnly": true, "type": "boolean" }, "loanId": { "description": "The loan identifier that the documents belongs to.", "nullable": true, "type": "string" }, "metaData": { "$ref": "#/components/schemas/MetaData" }, "personId": { "description": "The borrower's identifier that the documents belongs to.", "readOnly": true, "type": "string" }, "rejectionReason": { "description": "The reason why the document was rejected. This is a free text. Normally displayed in UI.", "type": "string" }, "sensitiveData": { "description": "Set this flag to `true` if this document has sensitive information, such as PII. The flag is used for\nproper authorization of access to the information.\n", "type": "boolean" }, "status": { "$ref": "#/components/schemas/DocumentStatus" }, "templateVersionId": { "description": "Peach internal template identifier that was used to render the document.", "nullable": true, "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user who last updated the document.\nCan be an borrower, agent, or automated system process.\n" }, "uploadedAt": { "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "uploadedBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for uploading the document.\nCan be an borrower, agent, or automated system process.\n" }, "verifiedAt": { "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "verifiedBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for verifing the document.\nCan be an agent or automated system process.\n" } }, "type": "object" }, "DocumentType": { "description": "The document type.", "enum": [ "loanTermsAgreementOnly", "loanTILDisclosureOnly", "loanTermsAndTILCombined", "loanTermsChangeAgreement", "loanAutopayAgreement", "loanStatement", "loanSettlementAgreement", "privacyPolicyLender", "privacyPolicyServicer", "termsOfServiceLender", "termsOfServiceServicer", "caseDocument", "disclosure", "evidence", "otherStatement", "other" ], "type": "string" }, "DocumentDescriptorCreate": { "allOf": [ { "$ref": "#/components/schemas/BaseWithExternalIdMixin" }, { "$ref": "#/components/schemas/DocumentDescriptorFields" }, { "properties": { "type": { "$ref": "#/components/schemas/DocumentType" } }, "required": [ "type" ], "type": "object" } ] }, "DocumentDescriptorResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseWithExternalIdMixin" }, { "$ref": "#/components/schemas/DocumentDescriptorFields" }, { "properties": { "type": { "$ref": "#/components/schemas/DocumentType" } }, "type": "object" } ] }, "EmployeeBase": { "properties": { "firstName": { "description": "The employee's first name.", "maxLength": 50, "minLength": 1, "type": "string" }, "lastName": { "description": "The employee's last name.", "maxLength": 50, "minLength": 1, "type": "string" } }, "type": "object" }, "Team": { "description": "A team is a named grouping of Employees", "properties": { "email": { "description": "The group email (or listserve) associated with this team.", "nullable": true, "type": "string" }, "employeeCount": { "description": "The number of employees on this team.", "readOnly": true, "type": "integer" }, "externalId": { "description": "The lender's external identifier of the team.", "nullable": true, "type": "string" }, "id": { "readOnly": true, "type": "string" }, "name": { "description": "The name of the team—e.g., \"Engineering\", \"Operations\", \"Customer Support\". Must be unique.", "minLength": 1, "type": "string" } }, "type": "object" }, "Employee": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "$ref": "#/components/schemas/EmployeeBase" }, { "description": "An employee in the company", "properties": { "assignedInvestorIds": { "description": "The unique identifiers of the investors assigned to the employee.\n", "items": { "$ref": "#/components/schemas/AnyId" }, "readOnly": true, "type": "array" }, "availableAndPermittedTasktypes": { "$ref": "#/components/schemas/TaskType" }, "companyId": { "description": "The unique company identifier.", "readOnly": true, "type": "string" }, "displayName": { "description": "The agent's first and last name, if set. Otherwise, their email\naddress.\n", "nullable": true, "readOnly": true, "type": "string" }, "email": { "description": "The employee's email address.", "maxLength": 100, "minLength": 1, "nullable": true, "type": "string" }, "externalId": { "description": "The lender's external identifier for the employee.", "nullable": true, "type": "string" }, "id": { "description": "A unique identifier for the employee", "readOnly": true, "type": "string" }, "jobName": { "description": "The name of position in the company—e.g., \"CEO\", \"Agent\", \"Supervisor\"", "maxLength": 100, "minLength": 1, "nullable": true, "type": "string" }, "managerEmployeeId": { "$ref": "#/components/schemas/AnyId", "description": "The ID of the employee's manager", "nullable": true }, "object": { "default": "Employee", "enum": [ "Employee" ], "readOnly": true, "type": "string" }, "phone": { "description": "The employee's phone number.", "maxLength": 16, "minLength": 1, "nullable": true, "type": "string" }, "teams": { "items": { "$ref": "#/components/schemas/Team" }, "type": "array" }, "user": { "allOf": [ { "$ref": "#/components/schemas/UserBasic" }, { "readOnly": true } ], "description": "The user associated with this employee" }, "userId": { "description": "The ID of the user associated with this employee", "type": "string", "writeOnly": true } }, "type": "object" } ] }, "EmailSignatureUpdate": { "description": "An email signature for an employee", "properties": { "contentHtml": { "description": "The HTML email signature content", "maxLength": 10000, "minLength": 0, "nullable": true, "type": "string" }, "enabled": { "description": "Whether the email signature is enabled. If true, new emails should include the signature\nwhen drafted.\n", "nullable": false, "type": "boolean" } }, "type": "object" }, "EmailSignature": { "allOf": [ { "$ref": "#/components/schemas/EmailSignatureUpdate" }, { "description": "An email signature for an employee", "properties": { "contentText": { "description": "The plain text version of the email signature content. This is generated from the `contentHtml` field\nand cannot be set.\n", "nullable": false, "readOnly": true, "type": "string" }, "employeeId": { "description": "The ID of the employee associated with this email signature.", "readOnly": true, "type": "string" }, "lastUpdatedAt": { "description": "The last time the email signature was updated.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" } }, "type": "object" } ] }, "personId": { "description": "A Borrower's unique identifier.", "type": "string" }, "readOnlyExternalId": { "nullable": true, "readOnly": true, "type": "string" }, "loanId": { "description": "Loan's unique identifier.", "type": "string" }, "BaseEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "companyId": { "description": "Company's unique identifier.", "type": "string" }, "creatingMessageId": { "description": "The message ID responsible for creating this event.", "type": "string" }, "discriminator": { "description": "String indicating the type of the parent object.", "type": "string" }, "effectiveAt": { "description": "The date and time at which the event was effective. This may differ from the date of creation.", "format": "date-time", "type": "string" }, "id": { "description": "Event's unique identifier.", "type": "string" }, "parentId": { "description": "Unique identifier of the parent object for the event.", "type": "string" } }, "type": "object" } ] }, "LoanEvent": { "allOf": [ { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "loanExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" } }, "type": "object" }, { "$ref": "#/components/schemas/BaseEvent" } ] }, "condition": { "enum": [ "balanceNA", "balanceBroken", "balanceRed", "balanceYellow", "balanceGreen" ], "type": "string" }, "periodId": { "description": "Period's unique identifier.", "type": "string" }, "AutopayPaymentRescheduledEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "condition": { "$ref": "#/components/schemas/condition" }, "eventType": { "enum": [ "autopay.payment.rescheduled" ], "type": "string" }, "periodId": { "$ref": "#/components/schemas/periodId" } }, "type": "object" } ], "title": "autopay.payment.rescheduled" }, "AutopayPaymentCanceledEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "condition": { "$ref": "#/components/schemas/condition" }, "eventType": { "enum": [ "autopay.payment.canceled" ], "type": "string" }, "periodId": { "$ref": "#/components/schemas/periodId" } }, "type": "object" } ], "title": "autopay.payment.canceled" }, "autopayCancellationReason": { "enum": [ "invalidPaymentMethod", "paymentMethodRemoved", "tooManyFailedAttempts", "loanFrozen", "loanAccelerated", "loanChargedOff", "loanPaidOff", "canceledByUser", "loanTermsChanged" ], "type": "string" }, "CancelAutopayScheduleEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "cancellationReason": { "$ref": "#/components/schemas/autopayCancellationReason" }, "eventType": { "enum": [ "autopay.schedule.cancel" ], "type": "string" } }, "type": "object" } ], "title": "autopay.schedule.cancel" }, "AutopayScheduleChangedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "autopay.schedule.changed" ], "type": "string" } }, "type": "object" } ], "title": "autopay.schedule.changed" }, "cardId": { "description": "Card's unique identifier.", "type": "string" }, "CardReplacementRequestedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "cardId": { "$ref": "#/components/schemas/cardId" }, "eventType": { "enum": [ "card.replacement.requested" ], "type": "string" }, "loanId": { "$ref": "#/components/schemas/loanId" } }, "type": "object" } ], "title": "card.replacement.requested" }, "CardCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "cardId": { "$ref": "#/components/schemas/cardId" }, "eventType": { "enum": [ "card.created" ], "type": "string" }, "loanId": { "$ref": "#/components/schemas/loanId" } }, "type": "object" } ], "title": "card.created" }, "cardStatus": { "description": "The status of the card.", "enum": [ "inactive", "pendingActivation", "pendingFulfillment", "active", "paused", "suspended", "terminated", "canceled", "expired", "invalid" ], "type": "string" }, "cardStatusChangeReasonCode": { "enum": [ "cardCanceled", "cardExpired", "cardInvalid", "cardClosed", "cardDamaged", "cardFraudulent", "cardInactive", "cardLost", "cardPFraud", "cardSuspended", "cardUnauthorized", "cardAcceptorActivityQuestionable", "cardStolen" ], "type": "string" }, "CardStatusChangedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "cardId": { "$ref": "#/components/schemas/cardId" }, "eventType": { "enum": [ "card.status.changed" ], "type": "string" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "newStatus": { "$ref": "#/components/schemas/cardStatus" }, "oldStatus": { "$ref": "#/components/schemas/cardStatus" }, "statusChangeReasonCode": { "$ref": "#/components/schemas/cardStatusChangeReasonCode" } }, "type": "object" } ], "title": "card.status.changed" }, "caseId": { "description": "Case's unique identifier.", "type": "string" }, "CaseEvent": { "allOf": [ { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "caseExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "caseId": { "$ref": "#/components/schemas/caseId" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" } }, "type": "object" }, { "$ref": "#/components/schemas/BaseEvent" } ] }, "associatedId": { "description": "Associated object's unique identifier.", "type": "string" }, "associatedObject": { "description": "Associated object type.", "type": "string" }, "CaseAssociationAddedEvent": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" }, { "properties": { "associatedId": { "$ref": "#/components/schemas/associatedId" }, "associatedObject": { "$ref": "#/components/schemas/associatedObject" }, "eventType": { "enum": [ "case.association.added" ], "type": "string" } }, "type": "object" } ], "title": "case.association.added" }, "CaseAssociationRemovedEvent": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" }, { "properties": { "associatedId": { "$ref": "#/components/schemas/associatedId" }, "associatedObject": { "$ref": "#/components/schemas/associatedObject" }, "eventType": { "enum": [ "case.association.removed" ], "type": "string" } }, "type": "object" } ], "title": "case.association.removed" }, "CaseDoNotInteractCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" }, { "properties": { "eventType": { "enum": [ "case.donotinteract.created" ], "type": "string" } }, "type": "object" } ], "title": "case.donotinteract.created" }, "CaseDoNotInteractDeletedEvent": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" }, { "properties": { "eventType": { "enum": [ "case.donotinteract.deleted" ], "type": "string" } }, "type": "object" } ], "title": "case.donotinteract.deleted" }, "CaseDoNotInteractUpdatedEvent": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" }, { "properties": { "eventType": { "enum": [ "case.donotinteract.updated" ], "type": "string" } }, "type": "object" } ], "title": "case.donotinteract.updated" }, "JSONPatchOpAddReplaceTest": { "properties": { "op": { "enum": [ "add", "replace", "test" ], "type": "string" }, "value": {} }, "required": [ "op", "value" ], "type": "object" }, "JSONPatchOpMoveCopy": { "properties": { "from": { "type": "string" }, "op": { "enum": [ "move", "copy" ], "type": "string" } }, "required": [ "op", "from" ], "type": "object" }, "JSONPatchOpRemove": { "properties": { "op": { "enum": [ "remove" ], "type": "string" } }, "required": [ "op" ], "type": "object" }, "JSONPatchOp": { "allOf": [ { "properties": { "path": { "type": "string" } }, "required": [ "path" ], "type": "object" }, { "anyOf": [ { "$ref": "#/components/schemas/JSONPatchOpAddReplaceTest" }, { "$ref": "#/components/schemas/JSONPatchOpMoveCopy" }, { "$ref": "#/components/schemas/JSONPatchOpRemove" } ] } ] }, "ChangeEvent": { "allOf": [ { "properties": { "changeType": { "enum": [ "create", "update", "delete" ], "type": "string" }, "jsonPatch": { "items": { "$ref": "#/components/schemas/JSONPatchOp" }, "type": "array" } }, "type": "object" }, { "$ref": "#/components/schemas/BaseEvent" } ] }, "CaseDoNotInteractChangedEvent": { "allOf": [ { "properties": { "caseId": { "$ref": "#/components/schemas/caseId" }, "doNotInteractId": { "description": "DNI's unique identifier", "type": "string" }, "eventType": { "enum": [ "case.donotinteract.changed" ], "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/ChangeEvent" } ], "title": "case.donotinteract.changed" }, "CaseDoNotInteractExpiredEvent": { "allOf": [ { "properties": { "eventType": { "enum": [ "case.donotinteract.expired" ], "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseEvent" } ], "title": "case.donotinteract.expired" }, "CaseEscalationChangedEvent": { "allOf": [ { "properties": { "caseId": { "$ref": "#/components/schemas/caseId" }, "escalationId": { "description": "Escalation's unique identifier", "type": "string" }, "eventType": { "enum": [ "case.escalation.changed" ], "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/ChangeEvent" } ], "title": "case.escalation.changed" }, "CaseCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" }, { "properties": { "eventType": { "enum": [ "case.created" ], "type": "string" } }, "type": "object" } ], "description": "*** DEPRECATED ***\nThis event is being replaced by `case.changed` with a `changeType` of `create`. `case.created` will still appear in API\nresponses for historical events, but new events will use `case.changed`.\n", "title": "case.created" }, "CaseUpdatedEvent": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" }, { "properties": { "eventType": { "enum": [ "case.updated" ], "type": "string" } }, "type": "object" } ], "description": "*** DEPRECATED ***\nThis event is being replaced by `case.changed` with a `changeType` of `update`. `case.updated` will still appear in API\nresponses for historical events, but new events will use `case.changed`.\n", "title": "case.updated" }, "CaseDeletedEvent": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" }, { "properties": { "eventType": { "enum": [ "case.deleted" ], "type": "string" } }, "type": "object" } ], "description": "*** DEPRECATED ***\nThis event was never used and will not appear in API requests.\n", "title": "case.deleted" }, "CaseChangedEvent": { "allOf": [ { "properties": { "caseId": { "$ref": "#/components/schemas/caseId" }, "eventType": { "enum": [ "case.changed" ], "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/ChangeEvent" } ], "title": "case.changed" }, "contactId": { "description": "Contact's unique identifier.", "type": "string" }, "ContactEvent": { "allOf": [ { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "contactExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "contactId": { "$ref": "#/components/schemas/contactId" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" } }, "type": "object" }, { "$ref": "#/components/schemas/BaseEvent" } ] }, "ContactCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/ContactEvent" }, { "properties": { "eventType": { "enum": [ "contact.created" ], "type": "string" } }, "type": "object" } ], "title": "contact.created" }, "ContactUpdatedEvent": { "allOf": [ { "$ref": "#/components/schemas/ContactEvent" }, { "properties": { "eventType": { "enum": [ "contact.updated" ], "type": "string" } }, "type": "object" } ], "title": "contact.updated" }, "ContactDeletedEvent": { "allOf": [ { "$ref": "#/components/schemas/ContactEvent" }, { "properties": { "eventType": { "enum": [ "contact.deleted" ], "type": "string" } }, "type": "object" } ], "title": "contact.deleted" }, "InteractionBlockedEvent": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" }, { "properties": { "contactExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "contactId": { "$ref": "#/components/schemas/contactId" }, "eventType": { "enum": [ "interaction.blocked" ], "type": "string" } }, "type": "object" } ], "description": "*** DEPRECATED ***\nThis event was never used and will not appear in API requests.\n", "title": "interaction.blocked" }, "CloseReason": { "description": "The description of the reason why the account was closed. If passed,\nthe `closeReason` value will be used in the `locLineClosed` communication template.\nMake sure to phrase the copy as a full sentence or paragraph.\n", "type": "string" }, "CloseReasonDetails": { "default": "other", "description": "The reason why the account was closed.\nThe reasons:\n - `requestedByBorrower` - a borrower requested to close the account.\n - `inactivity` - the account was closed by lender due to inactivity.\n - `terms` - the account was closed by lender because it was created with wrong terms or terms changed later (e.g. re-underwriting, charge off, bankruptcy).\n - `technicalIssue` - the account was closed by lender due to a technical issue.\n - `fraud` - the account was closed by lender due to fraud.\n - `other` - the account was closed by lender due to a reason not listed above.\n", "enum": [ "requestedByBorrower", "inactivity", "terms", "technicalIssue", "fraud", "other" ], "type": "string" }, "CloseRequestedByBorrower": { "description": "Set to true if a borrower requested to close the account.\nNote: This attribute has been deprecated, and you should use `closeReasonDetails` instead.\n - If you pass both `closeRequestedByBorrower` and `closeReasonDetails`, the system will ignore the `closeRequestedByBorrower` attribute.\n - If you pass `closeRequestedByBorrower` but not `closeReasonDetails`, the system will set `closeReasonDetails=requestedByBorrower`.\n", "nullable": true, "type": "boolean" }, "LoanCloseSendNotice": { "default": true, "description": "When set to `true`, the system will send a `locLineClosed` notice to the borrower.\n", "type": "boolean" }, "LoanClosedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "caseId": { "$ref": "#/components/schemas/caseId" }, "closeReason": { "$ref": "#/components/schemas/CloseReason" }, "closeReasonDetails": { "$ref": "#/components/schemas/CloseReasonDetails" }, "closeRequestedByBorrower": { "$ref": "#/components/schemas/CloseRequestedByBorrower" }, "eventType": { "enum": [ "loan.closed" ], "type": "string" }, "sendNotice": { "$ref": "#/components/schemas/LoanCloseSendNotice" } }, "type": "object" } ], "title": "loan.closed" }, "LoanCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.created" ], "type": "string" } }, "type": "object" } ], "title": "loan.created" }, "CaseId": { "properties": { "caseId": { "description": "An identifier for an existing case.", "type": "string" } }, "type": "object" }, "LoanCreditLimitChangedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "adverseActionReason": { "description": "The reason why the credit limit was changed.", "type": "string" }, "creditLimitAmount": { "description": "The new credit limit amount.", "type": "number" }, "eventType": { "enum": [ "loan.credit.limit.changed" ], "type": "string" }, "sendNotice": { "description": "Whether a notice was sent to the borrower", "type": "boolean" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ], "title": "loan.credit.limit.changed" }, "DrawCreditLimitChangedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "creditLimitAmount": { "description": "The new credit limit amount.", "type": "number" }, "creditLimitPercentage": { "description": "The draw's credit limit as a percentage of the loan's credit limit", "type": "number" }, "eventType": { "enum": [ "draw.credit.limit.changed" ], "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ], "title": "draw.credit.limit.changed" }, "LoanCurrentEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.current" ], "type": "string" }, "statusChangedDate": { "format": "date", "type": "string" } }, "type": "object" } ], "title": "loan.current" }, "LoanFeeCapitalizedEvent": { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "loan.fee.capitalized" ], "type": "string" }, "expectedPaymentId": { "$ref": "#/components/schemas/AnyId" }, "feeTypeId": { "$ref": "#/components/schemas/AnyId" }, "loanFeeId": { "$ref": "#/components/schemas/AnyId" }, "loanId": { "$ref": "#/components/schemas/loanId" } }, "title": "loan.fee.capitalized", "type": "object" }, "LoanOverdueEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.overdue" ], "type": "string" }, "overdueNumberDays": { "type": "number" }, "overdueTotalAmount": { "format": "float", "type": "number" }, "statusChangedDate": { "format": "date", "type": "string" } }, "type": "object" } ], "title": "loan.overdue" }, "LoanOverdueUpdateEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.overdue.update" ], "type": "string" }, "overdueNumberDays": { "type": "number" }, "overdueTotalAmount": { "format": "float", "type": "number" }, "statusChangedDate": { "format": "date", "type": "string" } }, "type": "object" } ], "title": "loan.overdue.update" }, "LoanLateFeeBookedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.latefee.booked" ], "type": "string" }, "expectedPaymentId": { "$ref": "#/components/schemas/AnyId" } }, "type": "object" } ], "title": "loan.latefee.booked" }, "LoanMigrationSucceededEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.migration.succeeded" ], "type": "string" }, "migrationEventCreatingMessageId": { "type": "string" } }, "type": "object" } ], "title": "loan.migration.succeeded" }, "LoanMigrationFailedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.migration.failed" ], "type": "string" }, "migrationEventCreatingMessageId": { "type": "string" } }, "type": "object" } ], "title": "loan.migration.failed" }, "LoanModificationFeeBookedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.modificationfee.booked" ], "type": "string" }, "expectedPaymentId": { "$ref": "#/components/schemas/AnyId" } }, "type": "object" } ], "title": "loan.modificationfee.booked" }, "LoanFeeBooked": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.fee.booked" ], "type": "string" }, "expectedPaymentId": { "$ref": "#/components/schemas/AnyId" }, "feeType": { "enum": [ "foreignTransactionFee", "lateFee", "modificationFee", "purchaseFee", "nsfFee", "serviceFee" ], "type": "string" } }, "type": "object" } ], "title": "loan.fee.booked" }, "LoanFeeCanceledEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "caseId": { "$ref": "#/components/schemas/CaseId" }, "eventType": { "enum": [ "loan.fee.canceled" ], "type": "string" }, "expectedPaymentId": { "$ref": "#/components/schemas/AnyId" }, "feeChargedAt": { "format": "date-time", "type": "string" }, "feeTypeId": { "$ref": "#/components/schemas/AnyId" }, "loanFeeId": { "$ref": "#/components/schemas/AnyId" }, "lockId": { "nullable": true, "type": "string" } }, "type": "object" } ], "title": "loan.fee.canceled" }, "LoanFeeChangedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "caseId": { "$ref": "#/components/schemas/CaseId" }, "eventType": { "enum": [ "loan.fee.changed" ], "type": "string" }, "expectedBalanceImpact": { "enum": [ "increase", "decrease", "unknown" ], "type": "string" }, "expectedPaymentId": { "$ref": "#/components/schemas/AnyId" }, "feeChargedAt": { "format": "date-time", "type": "string" }, "feeTypeId": { "$ref": "#/components/schemas/AnyId" }, "loanFeeId": { "$ref": "#/components/schemas/AnyId" }, "lockId": { "nullable": true, "type": "string" }, "newAmount": { "nullable": true, "type": "number" }, "oldAmount": { "type": "number" } }, "type": "object" } ], "title": "loan.fee.changed" }, "LoanOwnerChangedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.ownerchanged" ], "type": "string" } }, "type": "object" } ], "title": "loan.ownerchanged" }, "drawId": { "description": "Draw's unique identifier.", "type": "string" }, "RemainingBalancesDeferredEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "deferralType": { "enum": [ "capitalizeRemainingBalance" ], "nullable": false, "type": "string" }, "drawIds": { "items": { "$ref": "#/components/schemas/drawId" }, "type": "array" }, "dueDates": { "items": { "format": "date", "type": "string" }, "type": "array" }, "eventType": { "enum": [ "loan.remainingbalances.deferred" ], "type": "string" }, "totalDeferredAmount": { "format": "float", "type": "number" } }, "type": "object" } ], "title": "loan.remainingbalances.deferred" }, "LoanPromoProgramActivatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.promoprogram.activated" ], "type": "string" }, "promoId": { "$ref": "#/components/schemas/AnyId" } }, "type": "object" } ], "title": "loan.promoprogram.activated" }, "LoanPromoProgramCanceledEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.promoprogram.canceled" ], "type": "string" }, "promoId": { "$ref": "#/components/schemas/AnyId" } }, "type": "object" } ], "title": "loan.promoprogram.canceled" }, "LoanPromoProgramCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.promoprogram.created" ], "type": "string" }, "promoId": { "$ref": "#/components/schemas/AnyId" } }, "type": "object" } ], "title": "loan.promoprogram.created" }, "LoanPromoProgramExercisedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.promoprogram.exercised" ], "type": "string" }, "promoId": { "$ref": "#/components/schemas/AnyId" } }, "type": "object" } ], "title": "loan.promoprogram.exercised" }, "LoanPromoProgramReactivatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.promoprogram.reactivated" ], "type": "string" }, "promoId": { "$ref": "#/components/schemas/AnyId" } }, "type": "object" } ], "title": "loan.promoprogram.reactivated" }, "LoanPromoProgramUpdatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.promoprogram.updated" ], "type": "string" }, "promoId": { "$ref": "#/components/schemas/AnyId" } }, "type": "object" } ], "title": "loan.promoprogram.updated" }, "LoanRateCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.rate.created" ], "type": "string" } }, "type": "object" } ], "title": "loan.rate.created" }, "LoanRateUpdatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.rate.updated" ], "type": "string" } }, "type": "object" } ], "title": "loan.rate.updated" }, "LoanRefundedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.refunded" ], "type": "string" } }, "type": "object" } ], "title": "loan.refunded" }, "LoanReimbursementInitiatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.reimbursement.initiated" ], "type": "string" } }, "type": "object" } ], "title": "loan.reimbursement.initiated" }, "LoanReimbursementProcessedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.reimbursement.processed" ], "type": "string" } }, "type": "object" } ], "title": "loan.reimbursement.processed" }, "LoanStatusChangedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.statuschanged" ], "type": "string" }, "newStatus": { "$ref": "#/components/schemas/LoanStatus" }, "oldStatus": { "$ref": "#/components/schemas/LoanStatus" } }, "type": "object" } ], "title": "loan.statuschanged" }, "PeriodStartedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "dueDate": { "description": "The due date associated with the period.", "format": "date-time", "type": "string" }, "eventType": { "enum": [ "loan.period.started" ], "type": "string" }, "periodId": { "$ref": "#/components/schemas/periodId" } }, "required": [ "dueDate" ], "type": "object" } ], "title": "loan.period.started" }, "ObligationStatusChangedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "loan.obligation.statuschanged" ], "type": "string" }, "isOverdue": { "description": "The new obligation status to be recorded\n", "type": "boolean" } }, "required": [ "isOverdue" ], "type": "object" } ], "title": "loan.obligation.statuschanged" }, "previousInteractionId": { "description": "If a previous interaction identifier is provided, the current and previous interactions will be linked. This can either be Peach's or a lender's external identifier.", "nullable": true, "type": "string" }, "supercaseBulkOperationId": { "description": "If a `SupercaseBulkOperation` created this event, this is that ID", "nullable": true, "type": "string" }, "SendCommunicationEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "attachments": { "description": "An optional list of documents to attach to the outgoing email.\n", "items": { "description": "A document descriptor ID.", "type": "string" }, "type": "array" }, "caseId": { "$ref": "#/components/schemas/caseId" }, "channel": { "$ref": "#/components/schemas/InteractionChannel" }, "contactId": { "$ref": "#/components/schemas/contactId" }, "context": { "description": "Additional context to be passed when creating a message from preset templates for communication\n", "type": "object" }, "eventType": { "enum": [ "communication.send" ], "type": "string" }, "isTransactional": { "default": true, "type": "boolean" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "loanIds": { "items": { "type": "string" }, "type": "array" }, "personId": { "$ref": "#/components/schemas/personId" }, "previousInteractionId": { "$ref": "#/components/schemas/previousInteractionId" }, "subject": { "$ref": "#/components/schemas/InteractionSubject" }, "supercaseBulkOperationId": { "$ref": "#/components/schemas/supercaseBulkOperationId" }, "theme": { "$ref": "#/components/schemas/InteractionTheme" } }, "required": [ "subject", "personId" ], "type": "object" } ], "title": "communication.send" }, "statementId": { "description": "Statement's unique identifier.", "type": "string" }, "StatementCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "eventType": { "enum": [ "statement.created" ], "type": "string" }, "loanExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "periodId": { "$ref": "#/components/schemas/periodId" }, "statementId": { "$ref": "#/components/schemas/statementId" } }, "type": "object" } ], "title": "statement.created" }, "ownerId": { "description": "Payment instrument owner's unique identifier. Currently, the owner can be a borrower, investor, broker or payment processor.", "type": "string" }, "ownerType": { "description": "Type of owner of the payment instrument.", "enum": [ "person", "investor", "broker", "paymentProcessor" ], "type": "string" }, "paymentInstrumentId": { "description": "Payment Instrument's unique identifier.", "type": "string" }, "PaymentInstrumentCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId", "nullable": true }, "eventType": { "enum": [ "payment.instrument.created" ], "type": "string" }, "ownerId": { "$ref": "#/components/schemas/ownerId" }, "ownerType": { "$ref": "#/components/schemas/ownerType" }, "paymentInstrumentExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "paymentInstrumentId": { "$ref": "#/components/schemas/paymentInstrumentId" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" } }, "type": "object" } ], "title": "payment.instrument.created" }, "PaymentInstrumentUpdatedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId", "nullable": true }, "changes": { "type": "object" }, "eventType": { "enum": [ "payment.instrument.updated" ], "type": "string" }, "ownerId": { "$ref": "#/components/schemas/ownerId" }, "ownerType": { "$ref": "#/components/schemas/ownerType" }, "paymentInstrumentId": { "$ref": "#/components/schemas/paymentInstrumentId" } }, "type": "object" } ], "title": "payment.instrument.updated" }, "PaymentInstrumentDeactivatedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId", "nullable": true }, "eventType": { "enum": [ "payment.instrument.deactivated" ], "type": "string" }, "ownerId": { "$ref": "#/components/schemas/ownerId" }, "ownerType": { "$ref": "#/components/schemas/ownerType" }, "paymentInstrumentExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "paymentInstrumentId": { "$ref": "#/components/schemas/paymentInstrumentId" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" } }, "type": "object" } ], "title": "payment.instrument.deactivated" }, "PersonBankruptcyDeceasedStartMonitoringEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "person.monitoring.bankruptcy.started" ], "type": "string" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" } }, "type": "object" } ], "title": "person.monitoring.bankruptcy.started" }, "consentId": { "description": "Consent's unique identifier.", "type": "string" }, "PersonConsentUpdatedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "consentId": { "$ref": "#/components/schemas/consentId" }, "eventType": { "enum": [ "person.consent.updated" ], "type": "string" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" } }, "type": "object" } ], "title": "person.consent.updated" }, "PersonCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "person.created" ], "type": "string" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" } }, "type": "object" } ], "title": "person.created" }, "PersonSCRAStartMonitoringEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "person.monitoring.scra.start" ], "type": "string" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" } }, "type": "object" } ], "title": "person.monitoring.scra.start" }, "transactionId": { "description": "Transaction's unique identifier.", "type": "string" }, "PaymentChargebackEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "amount": { "description": "The amount of the chargeback", "type": "number" }, "borrowerId": { "$ref": "#/components/schemas/personId" }, "description": { "description": "The description of the chargeback", "type": "string" }, "eventType": { "enum": [ "payment.chargeback" ], "type": "string" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "reasonCode": { "description": "The reason code", "type": "string" }, "transactionId": { "$ref": "#/components/schemas/transactionId" } }, "type": "object" } ], "title": "payment.chargeback" }, "PaymentChargebackReversedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "amount": { "description": "The amount of the chargeback", "type": "number" }, "borrowerId": { "$ref": "#/components/schemas/personId" }, "description": { "description": "The description of the chargeback", "type": "string" }, "eventType": { "enum": [ "payment.chargeback.reversed" ], "type": "string" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "reasonCode": { "description": "The reason code", "type": "string" }, "transactionId": { "$ref": "#/components/schemas/transactionId" } }, "type": "object" } ], "title": "payment.chargeback.reversed" }, "PaymentFailedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "eventType": { "enum": [ "payment.failed" ], "type": "string" }, "transactionExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "transactionId": { "$ref": "#/components/schemas/transactionId" } }, "type": "object" } ], "title": "payment.failed" }, "PaymentInitiatedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "payment.initiated" ], "type": "string" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "transactionExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "transactionId": { "$ref": "#/components/schemas/transactionId" } }, "type": "object" } ], "title": "payment.initiated" }, "PaymentPendingEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "payment.pending" ], "type": "string" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "transactionExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "transactionId": { "$ref": "#/components/schemas/transactionId" } }, "type": "object" } ], "title": "payment.pending" }, "PaymentReversedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "amount": { "description": "The amount of the reversal", "type": "number" }, "borrowerExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "payment.reversed" ], "type": "string" }, "reversedAmount": { "description": "The sum of all of the reversals of the original transaction.", "type": "number" }, "reversedTransactionId": { "description": "Unique identifier of the original transaction.", "type": "string" }, "transactionExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "transactionId": { "$ref": "#/components/schemas/transactionId" } }, "type": "object" } ], "title": "payment.reversed" }, "PaymentScheduledEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "payment.scheduled" ], "type": "string" }, "personExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "transactionExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "transactionId": { "$ref": "#/components/schemas/transactionId" } }, "type": "object" } ], "title": "payment.scheduled" }, "PaymentSucceededEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "payment.succeeded" ], "type": "string" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "paymentInstrumentId": { "$ref": "#/components/schemas/paymentInstrumentId" }, "transactionExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "transactionId": { "$ref": "#/components/schemas/transactionId" } }, "type": "object" } ], "title": "payment.succeeded" }, "newScheduledDate": { "format": "date", "type": "string" }, "oldScheduledDate": { "format": "date", "type": "string" }, "PaymentRescheduledEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "payment.rescheduled" ], "type": "string" }, "loanExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "newScheduledDate": { "$ref": "#/components/schemas/newScheduledDate" }, "oldScheduledDate": { "$ref": "#/components/schemas/oldScheduledDate" }, "transactionExternalId": { "$ref": "#/components/schemas/readOnlyExternalId" }, "transactionId": { "$ref": "#/components/schemas/transactionId" } }, "type": "object" } ], "title": "payment.rescheduled" }, "paymentInstrumentType": { "enum": [ "bankAccount" ], "type": "string" }, "transactionCreatedAt": { "format": "date-time", "type": "string" }, "transactionCurrency": { "pattern": "[A-Z]{3}", "type": "string" }, "transactionIsExternal": { "type": "boolean" }, "transactionScheduledAmount": { "type": "number" }, "transactionScheduledDate": { "format": "date", "type": "string" }, "PaymentDueTodayEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "payment.due.today" ], "type": "string" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "paymentInstrumentId": { "$ref": "#/components/schemas/paymentInstrumentId" }, "paymentInstrumentType": { "$ref": "#/components/schemas/paymentInstrumentType" }, "transactionCreatedAt": { "$ref": "#/components/schemas/transactionCreatedAt" }, "transactionCurrency": { "$ref": "#/components/schemas/transactionCurrency" }, "transactionId": { "$ref": "#/components/schemas/transactionId" }, "transactionIsExternal": { "$ref": "#/components/schemas/transactionIsExternal" }, "transactionScheduledAmount": { "$ref": "#/components/schemas/transactionScheduledAmount" }, "transactionScheduledDate": { "$ref": "#/components/schemas/transactionScheduledDate" } }, "type": "object" } ], "title": "payment.due.today" }, "PaymentHoldDaysExpiredEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "payment.hold.days.expired" ], "type": "string" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "transactionId": { "$ref": "#/components/schemas/transactionId" } }, "type": "object" } ], "title": "payment.hold.days.expired" }, "purchaseId": { "description": "Purchase's unique identifier.", "type": "string" }, "PurchaseAuthorizedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "purchase.authorized" ], "type": "string" }, "purchaseId": { "$ref": "#/components/schemas/purchaseId" } }, "type": "object" } ], "title": "purchase.authorized" }, "PurchaseSettledEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "purchase.settled" ], "type": "string" }, "purchaseId": { "$ref": "#/components/schemas/purchaseId" } }, "type": "object" } ], "title": "purchase.settled" }, "PurchaseAppliedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "purchase.applied" ], "type": "string" }, "purchaseId": { "$ref": "#/components/schemas/purchaseId" } }, "type": "object" } ], "title": "purchase.applied" }, "lineOfCreditId": { "description": "Line of Credit's unique identifier.", "type": "string" }, "PurchaseCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "purchase.created" ], "type": "string" }, "lineOfCreditId": { "$ref": "#/components/schemas/lineOfCreditId" }, "purchaseId": { "$ref": "#/components/schemas/purchaseId" } }, "type": "object" } ], "title": "purchase.created" }, "newAmount": { "type": "number" }, "newStatus": { "type": "string" }, "oldAmount": { "type": "number" }, "oldStatus": { "type": "string" }, "PurchaseChangedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "eventType": { "enum": [ "purchase.changed" ], "type": "string" }, "lineOfCreditId": { "$ref": "#/components/schemas/lineOfCreditId" }, "newAmount": { "$ref": "#/components/schemas/newAmount" }, "newStatus": { "$ref": "#/components/schemas/newStatus" }, "oldAmount": { "$ref": "#/components/schemas/oldAmount" }, "oldStatus": { "$ref": "#/components/schemas/oldStatus" }, "purchaseId": { "$ref": "#/components/schemas/purchaseId" } }, "type": "object" } ], "title": "purchase.changed" }, "purchaseDisputeId": { "description": "Purchase dispute's unique identifier.", "type": "string" }, "purchaseDisputeStatus": { "enum": [ "unsubmitted", "submitted", "expired", "won", "lost", "canceled" ], "type": "string" }, "PurchaseDisputeCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "drawId": { "$ref": "#/components/schemas/drawId" }, "eventType": { "enum": [ "purchase.dispute.created" ], "type": "string" }, "isPastPurchaseDispute": { "description": "Whether the purchase dispute is for a past purchase or not. Past purchases are used in LOC migrations. Past purchases have effective dates before the migration cutoff date.", "type": "boolean" }, "purchaseDisputeId": { "$ref": "#/components/schemas/purchaseDisputeId" }, "purchaseId": { "$ref": "#/components/schemas/purchaseId" }, "status": { "$ref": "#/components/schemas/purchaseDisputeStatus" } }, "type": "object" } ], "title": "purchase.dispute.created" }, "PurchaseDisputeUpdatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "drawId": { "$ref": "#/components/schemas/drawId" }, "eventType": { "enum": [ "purchase.dispute.updated" ], "type": "string" }, "isPastPurchaseDispute": { "description": "Whether the purchase dispute is for a past purchase or not. Past purchases are used in LOC migrations. Past purchases have effective dates before the migration cutoff date.", "type": "boolean" }, "purchaseDisputeId": { "$ref": "#/components/schemas/purchaseDisputeId" }, "purchaseId": { "$ref": "#/components/schemas/purchaseId" }, "status": { "$ref": "#/components/schemas/purchaseDisputeStatus" } }, "type": "object" } ], "title": "purchase.dispute.updated" }, "creditAgencyId": { "description": "Credit agency's unique identifier.", "format": "date", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "LoanCreditReportingCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "creditAgencyId": { "$ref": "#/components/schemas/creditAgencyId" }, "eventType": { "enum": [ "loan.creditreporting.created" ], "type": "string" }, "startDate": { "$ref": "#/components/schemas/startDate" } }, "type": "object" } ], "title": "loan.creditreporting.created" }, "stopDate": { "format": "date", "type": "string" }, "LoanCreditReportingStoppedEvent": { "allOf": [ { "$ref": "#/components/schemas/LoanEvent" }, { "properties": { "caseId": { "$ref": "#/components/schemas/caseId" }, "creditAgencyId": { "$ref": "#/components/schemas/creditAgencyId" }, "eventType": { "enum": [ "loan.creditreporting.stopped" ], "type": "string" }, "stopDate": { "$ref": "#/components/schemas/stopDate" } }, "type": "object" } ], "title": "loan.creditreporting.stopped" }, "obligationId": { "description": "Obligation unique identifier.", "type": "string" }, "InterestCapitalizedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventType": { "enum": [ "loan.interest.capitalized" ], "type": "string" }, "feeAmount": { "description": "The fee amount capitalized.", "type": "number" }, "interestAmount": { "description": "The interest amount capitalized.", "type": "number" }, "isReplay": { "description": "`true` if capitalization was updated after the overdue date.\n", "type": "boolean" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "obligationId": { "$ref": "#/components/schemas/obligationId" } }, "type": "object" } ], "title": "loan.interest.capitalized" }, "achFileId": { "description": "The ACH File upload monitoring record ID.", "nullable": true, "type": "string" }, "paymentProcessorId": { "description": "The payment processor ID.", "type": "string" }, "ACHFileEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "achFileId": { "$ref": "#/components/schemas/achFileId" }, "fileName": { "$ref": "#/components/schemas/fileName" }, "processorId": { "$ref": "#/components/schemas/paymentProcessorId" } }, "required": [ "processorId", "fileName" ], "type": "object" } ] }, "ACHFileCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/ACHFileEvent" }, { "properties": { "eventType": { "enum": [ "ach.file.created" ], "type": "string" } }, "type": "object" } ], "title": "ach.file.created" }, "fileDestination": { "description": "The destination where we are going to store the ACH File.", "enum": [ "gcp", "sftp" ], "type": "string" }, "ACHFileUploadEvent": { "allOf": [ { "$ref": "#/components/schemas/ACHFileEvent" }, { "properties": { "fileDestination": { "$ref": "#/components/schemas/fileDestination" } }, "required": [ "fileDestination" ], "type": "object" } ] }, "ACHFileUploadAttemptedEvent": { "allOf": [ { "$ref": "#/components/schemas/ACHFileUploadEvent" }, { "properties": { "eventType": { "enum": [ "ach.file.upload.attempted" ], "type": "string" } }, "type": "object" } ], "title": "ach.file.upload.attempted" }, "ACHFileUploadFailedEvent": { "allOf": [ { "$ref": "#/components/schemas/ACHFileUploadEvent" }, { "properties": { "eventType": { "enum": [ "ach.file.upload.failed" ], "type": "string" } }, "type": "object" } ], "title": "ach.file.upload.failed" }, "ACHFileUploadSucceededEvent": { "allOf": [ { "$ref": "#/components/schemas/ACHFileUploadEvent" }, { "properties": { "eventType": { "enum": [ "ach.file.upload.succeeded" ], "type": "string" } }, "type": "object" } ], "title": "ach.file.upload.succeeded" }, "amount": { "type": "number" }, "transactionFailureReason": { "enum": [ "insufficientFunds", "chargeback", "accountClosed", "invalidAccount", "unknownReason", "invalidCvv", "invalidExpirationDate", "avsFailed", "networkError", "cardDeclined", "accountFrozen", "deceased", "invalidRouting", "paymentStopped", "microdepositsFailed", "incorrectNumber", "fraudulent", "unauthorizedDebit", "microdepositsAttemptFailed" ], "type": "string" }, "ReconciliationPaymentFailedEvent": { "allOf": [ { "$ref": "#/components/schemas/BaseEvent" }, { "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "eventType": { "enum": [ "reconciliation.payment.failed" ], "type": "string" }, "fromInstrumentId": { "$ref": "#/components/schemas/paymentInstrumentId" }, "reason": { "$ref": "#/components/schemas/transactionFailureReason" }, "settlementIds": { "items": { "$ref": "#/components/schemas/readOnlyExternalId" }, "type": "array" }, "toInstrumentId": { "$ref": "#/components/schemas/paymentInstrumentId" }, "transactionId": { "$ref": "#/components/schemas/transactionId" } }, "type": "object" } ], "title": "reconciliation.payment.failed" }, "replayId": { "description": "Replay's unique identifier.", "type": "string" }, "LoanBalanceChangedEvent": { "properties": { "balances": { "description": "The balances of the loan after the balance change.\nContains a subset of the fields found in the Get loan balances response body.\n", "properties": { "authorizedAmount": { "$ref": "#/components/schemas/AuthorizedAmount" }, "availableCreditAmount": { "description": "The available credit amount to use. If the borrower exceeded their credit limit, the `availableCreditAmount` will be zero.\n\nFor lines of credit only:\n - `availableCreditAmount` takes into account `authorizedAmount`. Authorized purchases decrease the `availableCreditAmount`.\n - The amount can be greater than `creditLimitAmount`. It happens only when the total amount of payments made by the borrower\n plus the total amount of service credits exceeds the line or draw balance. Any future purchases will first deplete the\n overpayment amount (also called `reimbursementAmount`).\n\nOnly applicable to lines of credit or installment loans with multi-advances.\n", "format": "float", "type": "number" }, "calculatedAt": { "description": "The date and time the balance was calculated.", "format": "date-time", "type": "string" }, "openToBuyAmount": { "$ref": "#/components/schemas/OpenToBuyAmount" }, "outstandingBalances": { "description": "When a loan is `active`, outstanding balances combine non-due, due, and overdue balances. When a loan is\n`accelerated`, outstanding balances are equal to non-accrual balances. When a loan is `chargedOff`,\noutstanding balances are equal to charged-off balances.\n", "properties": { "outstandingFeesAmount": { "description": "The fees portion of the `outstandingTotalAmount`.\n", "format": "float", "type": "number" }, "outstandingInterestAmount": { "description": "The interest portion of the `outstandingTotalAmount`.", "format": "float", "type": "number" }, "outstandingPrincipalAmount": { "description": "The principal portion of the `outstandingTotalAmount`.", "format": "float", "type": "number" }, "outstandingTotalAmount": { "description": "The total outstanding balance sums outstanding principal, interest, and fees. Also called the loan payoff amount.\n\nIf the loan is charged off, the outstanding totalAmount will be equal to the `chargedOffTotalAmount`.\n", "format": "float", "type": "number" } }, "type": "object" }, "overdueBalances": { "description": "Overdue balances represent balances that are overdue.", "properties": { "overdueTotalAmount": { "description": "The total overdue balance sums overdue principal, interest, and fees.", "format": "float", "type": "number" } }, "type": "object" }, "paidBalances": { "description": "If loan balance was affected by transaction(s) (e.g. payment), this object will contain details of the paid amounts.\nThe system will populate `paidBalances` attributes in two scenarios:\n\n1. A transaction, a payment or service credit, was applied without triggering a replay. In this scenario, amounts\n will show how much of the loan balance was paid by the transaction.\n\n2. A replay was triggered. In this scenario, the system will sum up how much of the loan balance was paid by all\n transactions that were reapplied from \"replay start timestamp\" until \"replay end timestamp\". If there were no\n transactions in the replay period that impacted the loan balance, the `paidTotalAmount` and other attributes in the object will be zeros.\n\nOutside of these scenarios, the values will be zero.\n", "properties": { "paidFeesAmount": { "description": "The amount of `paidTotalAmount` allocated to fees.", "format": "float", "type": "number" }, "paidInterestAmount": { "description": "The amount of `paidTotalAmount` allocated to interest.", "format": "float", "type": "number" }, "paidOverAmount": { "description": "Stores any excess amount that was not allocated to principal, interest or fees.\n\nFor example:\n- A check in amount greater than outstanding balance was applied.\n- The overpayment portion (aka balance owed to a borrower) will be reported as `paidOverAmount`.\n", "format": "float", "type": "number" }, "paidPrincipalAmount": { "description": "The amount of `paidTotalAmount` allocated to principal.", "format": "float", "type": "number" }, "paidReimbursementsAmount": { "description": "The total amount of reimbursements that were sent back to a borrower.", "format": "float", "type": "number" }, "paidTotalAmount": { "description": "The paid amount that impacted/lowered the balance.", "format": "float", "type": "number" } }, "type": "object" }, "reimbursementAmount": { "description": "The total amount that a lender owes to the borrower. The amount was not sent to the borrower yet.\nAfter a reimbursement is processed, the amount is reduced accordingly.\n", "format": "float", "type": "number" }, "utilizationAmount": { "$ref": "#/components/schemas/UtilizationAmount" } }, "type": "object" }, "borrowerId": { "$ref": "#/components/schemas/personId" }, "eventId": { "description": "The creatingMessageId of the event that caused the balance change.", "type": "string" }, "eventType": { "enum": [ "loan.balance.changed" ], "type": "string" }, "interestAccruedAmount": { "description": "The amount of interest accrued. Only set for daily loan maintenance and catchup interest accrual.", "format": "float", "nullable": true, "type": "number" }, "loanId": { "$ref": "#/components/schemas/loanId" }, "replayEndedAt": { "description": "Replay ended at timestamp. Only populated for replay events.", "format": "date-time", "nullable": true, "type": "string" }, "replayId": { "$ref": "#/components/schemas/replayId" }, "replayStartedAt": { "description": "Replay started at timestamp. Only populated for replay events.", "format": "date-time", "nullable": true, "type": "string" } }, "title": "loan.balance.changed", "type": "object" }, "supercaseId": { "description": "Supercase's unique identifier.", "type": "string" }, "SupercaseChangedEvent": { "allOf": [ { "properties": { "eventType": { "enum": [ "supercase.changed" ], "type": "string" }, "supercaseId": { "$ref": "#/components/schemas/supercaseId" } }, "type": "object" }, { "$ref": "#/components/schemas/ChangeEvent" } ], "title": "supercase.changed" }, "GenericEvent": { "properties": { "eventType": { "type": "string" } }, "title": "generic", "type": "object" }, "eventTypeDefinition": { "description": "The dotted event string.", "example": "loan.statuschanged", "type": "string" }, "EventPublic": { "anyOf": [ { "$ref": "#/components/schemas/AutopayPaymentRescheduledEvent" }, { "$ref": "#/components/schemas/AutopayPaymentCanceledEvent" }, { "$ref": "#/components/schemas/CancelAutopayScheduleEvent" }, { "$ref": "#/components/schemas/AutopayScheduleChangedEvent" }, { "$ref": "#/components/schemas/CardReplacementRequestedEvent" }, { "$ref": "#/components/schemas/CardCreatedEvent" }, { "$ref": "#/components/schemas/CardStatusChangedEvent" }, { "$ref": "#/components/schemas/CaseAssociationAddedEvent" }, { "$ref": "#/components/schemas/CaseAssociationRemovedEvent" }, { "$ref": "#/components/schemas/CaseDoNotInteractCreatedEvent" }, { "$ref": "#/components/schemas/CaseDoNotInteractDeletedEvent" }, { "$ref": "#/components/schemas/CaseDoNotInteractUpdatedEvent" }, { "$ref": "#/components/schemas/CaseDoNotInteractChangedEvent" }, { "$ref": "#/components/schemas/CaseDoNotInteractExpiredEvent" }, { "$ref": "#/components/schemas/CaseEscalationChangedEvent" }, { "$ref": "#/components/schemas/CaseCreatedEvent" }, { "$ref": "#/components/schemas/CaseUpdatedEvent" }, { "$ref": "#/components/schemas/CaseDeletedEvent" }, { "$ref": "#/components/schemas/CaseChangedEvent" }, { "$ref": "#/components/schemas/ContactCreatedEvent" }, { "$ref": "#/components/schemas/ContactUpdatedEvent" }, { "$ref": "#/components/schemas/ContactDeletedEvent" }, { "$ref": "#/components/schemas/InteractionBlockedEvent" }, { "$ref": "#/components/schemas/LoanClosedEvent" }, { "$ref": "#/components/schemas/LoanCreatedEvent" }, { "$ref": "#/components/schemas/LoanCreditLimitChangedEvent" }, { "$ref": "#/components/schemas/DrawCreditLimitChangedEvent" }, { "$ref": "#/components/schemas/LoanCurrentEvent" }, { "$ref": "#/components/schemas/LoanFeeCapitalizedEvent" }, { "$ref": "#/components/schemas/LoanOverdueEvent" }, { "$ref": "#/components/schemas/LoanOverdueUpdateEvent" }, { "$ref": "#/components/schemas/LoanLateFeeBookedEvent" }, { "$ref": "#/components/schemas/LoanMigrationSucceededEvent" }, { "$ref": "#/components/schemas/LoanMigrationFailedEvent" }, { "$ref": "#/components/schemas/LoanModificationFeeBookedEvent" }, { "$ref": "#/components/schemas/LoanFeeBooked" }, { "$ref": "#/components/schemas/LoanFeeCanceledEvent" }, { "$ref": "#/components/schemas/LoanFeeChangedEvent" }, { "$ref": "#/components/schemas/LoanOwnerChangedEvent" }, { "$ref": "#/components/schemas/RemainingBalancesDeferredEvent" }, { "$ref": "#/components/schemas/LoanPromoProgramActivatedEvent" }, { "$ref": "#/components/schemas/LoanPromoProgramCanceledEvent" }, { "$ref": "#/components/schemas/LoanPromoProgramCreatedEvent" }, { "$ref": "#/components/schemas/LoanPromoProgramExercisedEvent" }, { "$ref": "#/components/schemas/LoanPromoProgramReactivatedEvent" }, { "$ref": "#/components/schemas/LoanPromoProgramUpdatedEvent" }, { "$ref": "#/components/schemas/LoanRateCreatedEvent" }, { "$ref": "#/components/schemas/LoanRateUpdatedEvent" }, { "$ref": "#/components/schemas/LoanRefundedEvent" }, { "$ref": "#/components/schemas/LoanReimbursementInitiatedEvent" }, { "$ref": "#/components/schemas/LoanReimbursementProcessedEvent" }, { "$ref": "#/components/schemas/LoanStatusChangedEvent" }, { "$ref": "#/components/schemas/PeriodStartedEvent" }, { "$ref": "#/components/schemas/ObligationStatusChangedEvent" }, { "$ref": "#/components/schemas/SendCommunicationEvent" }, { "$ref": "#/components/schemas/StatementCreatedEvent" }, { "$ref": "#/components/schemas/PaymentInstrumentCreatedEvent" }, { "$ref": "#/components/schemas/PaymentInstrumentUpdatedEvent" }, { "$ref": "#/components/schemas/PaymentInstrumentDeactivatedEvent" }, { "$ref": "#/components/schemas/PersonBankruptcyDeceasedStartMonitoringEvent" }, { "$ref": "#/components/schemas/PersonConsentUpdatedEvent" }, { "$ref": "#/components/schemas/PersonCreatedEvent" }, { "$ref": "#/components/schemas/PersonSCRAStartMonitoringEvent" }, { "$ref": "#/components/schemas/PaymentChargebackEvent" }, { "$ref": "#/components/schemas/PaymentChargebackReversedEvent" }, { "$ref": "#/components/schemas/PaymentFailedEvent" }, { "$ref": "#/components/schemas/PaymentInitiatedEvent" }, { "$ref": "#/components/schemas/PaymentPendingEvent" }, { "$ref": "#/components/schemas/PaymentReversedEvent" }, { "$ref": "#/components/schemas/PaymentScheduledEvent" }, { "$ref": "#/components/schemas/PaymentSucceededEvent" }, { "$ref": "#/components/schemas/PaymentRescheduledEvent" }, { "$ref": "#/components/schemas/PaymentDueTodayEvent" }, { "$ref": "#/components/schemas/PaymentHoldDaysExpiredEvent" }, { "$ref": "#/components/schemas/PurchaseAuthorizedEvent" }, { "$ref": "#/components/schemas/PurchaseSettledEvent" }, { "$ref": "#/components/schemas/PurchaseAppliedEvent" }, { "$ref": "#/components/schemas/PurchaseCreatedEvent" }, { "$ref": "#/components/schemas/PurchaseChangedEvent" }, { "$ref": "#/components/schemas/PurchaseDisputeCreatedEvent" }, { "$ref": "#/components/schemas/PurchaseDisputeUpdatedEvent" }, { "$ref": "#/components/schemas/LoanCreditReportingCreatedEvent" }, { "$ref": "#/components/schemas/LoanCreditReportingStoppedEvent" }, { "$ref": "#/components/schemas/InterestCapitalizedEvent" }, { "$ref": "#/components/schemas/ACHFileCreatedEvent" }, { "$ref": "#/components/schemas/ACHFileUploadAttemptedEvent" }, { "$ref": "#/components/schemas/ACHFileUploadFailedEvent" }, { "$ref": "#/components/schemas/ACHFileUploadSucceededEvent" }, { "$ref": "#/components/schemas/ReconciliationPaymentFailedEvent" }, { "$ref": "#/components/schemas/LoanBalanceChangedEvent" }, { "$ref": "#/components/schemas/SupercaseChangedEvent" }, { "$ref": "#/components/schemas/GenericEvent" } ], "properties": { "eventType": { "$ref": "#/components/schemas/eventTypeDefinition" } }, "required": [ "eventType" ], "type": "object" }, "InteractionsPaging": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Interaction" }, "type": "array" } }, "type": "object" } ] }, "NoteCategory": { "default": "generic", "description": "Specifies the nature of a Note\n", "enum": [ "generic", "escalationCreateReason", "escalationUpdateReason", "escalationCancelReason" ], "type": "string" }, "NoteResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "archived": { "default": false, "description": "Set to `true` if the note has been archived.\n", "type": "boolean" }, "archivedAt": { "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "archivedBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for archiving the note.\nCan be an agent or automated system process.\n" }, "caseId": { "description": "Identifier of the case that the note belongs to.", "nullable": true, "readOnly": true, "type": "string" }, "category": { "$ref": "#/components/schemas/NoteCategory" }, "content": { "description": "The content of the note.", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for creating the note.\nCan be an agent or automated system process.\n" }, "deletedAt": { "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Latest user identifier who deleted the note." }, "edited": { "default": false, "description": "Indicates whether the note was edited.\n", "readOnly": true, "type": "boolean" }, "id": { "description": "The note identifier.", "readOnly": true, "type": "string" }, "important": { "default": false, "description": "Set to `true` if the note is important.\n", "type": "boolean" }, "interactionId": { "description": "Identifier of the interaction that the note belongs to.", "nullable": true, "readOnly": true, "type": "string" }, "object": { "default": "note", "enum": [ "note" ], "readOnly": true, "type": "string" }, "oldContent": { "type": "array" }, "pinned": { "default": false, "description": "Specify that this note should be sorted to the top of the list\nby default.\n", "type": "boolean" }, "sensitiveData": { "default": false, "description": "Indicates whether the note contains sensitive information.\n", "type": "boolean" }, "status": { "enum": [ "active", "inactive" ], "type": "string" }, "supercaseId": { "description": "Identifier of the supercase that the note belongs to.", "nullable": true, "readOnly": true, "type": "string" }, "taskableInstruction": { "default": false, "description": "Set to `true` if the note is intended to be an instruction which creates a review task.\n", "type": "boolean" }, "type": { "enum": [ "borrowerNote", "caseNote", "interactionNote", "supercaseGlobalNote", "supercasePrivateNote" ], "readOnly": true, "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for last updating the note.\nCan be an agent or automated system process.\n" } }, "type": "object" } ], "description": "A borrower, case, supercase or interaction can have a note associated with it. Each note can only be associated with one of these objects.\n", "title": "A borrower, case, supercase or interaction note" }, "NoteRequest": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "archived": { "default": false, "description": "Set to `true` if the note has been archived.\n", "type": "boolean" }, "archivedAt": { "format": "date-time", "readOnly": true, "type": "string" }, "archivedBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for archiving the note.\nCan be an agent or automated system process.\n" }, "caseId": { "description": "Identifier of the case that the note belongs to.", "nullable": true, "readOnly": true, "type": "string" }, "category": { "$ref": "#/components/schemas/NoteCategory" }, "content": { "description": "The content of the note.", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for creating the note.\nCan be an agent or automated system process.\n" }, "deletedAt": { "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for deleting the note.\nCan be an agent or automated system process.\n" }, "edited": { "default": false, "description": "Indicates whether the note was edited.\n", "readOnly": true, "type": "boolean" }, "id": { "description": "The note identifier.", "readOnly": true, "type": "string" }, "important": { "default": false, "description": "Set to `true` if the note is important.\n", "type": "boolean" }, "interactionId": { "description": "Identifier of the interaction that the note belongs to.", "nullable": true, "readOnly": true, "type": "string" }, "pinned": { "default": false, "description": "Specify that this note should be sorted to the top of the list\nby default.\n", "type": "boolean" }, "sensitiveData": { "default": false, "description": "Indicates whether the note contains sensitive information.\n", "type": "boolean" }, "status": { "enum": [ "active", "inactive" ], "type": "string" }, "supercaseId": { "description": "Identifier of the supercase that the note belongs to.", "nullable": true, "readOnly": true, "type": "string" }, "taskableInstruction": { "default": false, "description": "Set to `true` if the note is intended to be an instruction which creates a review task.\n", "type": "boolean" }, "type": { "enum": [ "borrowerNote", "caseNote", "interactionNote", "supercaseGlobalNote", "supercasePrivateNote" ], "readOnly": true, "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for last updating the note.\nCan be an agent or automated system process.\n" } }, "type": "object" } ], "description": "A borrower, case, supercase or interaction can have a note associated with it. Each note can only be associated with one of these objects.\n", "title": "A borrower, case, supercase or interaction note" }, "APIKeyDescription": { "description": "A description of the API key. This field is optional and can be used to provide additional context about the API key.\n", "maxLength": 200, "minLength": 1, "nullable": true, "type": "string" }, "WhitelistedIPs": { "description": "IP addresses or CIDR blocks for which to restrict access to this API key.\n", "example": [ "1.1.1.1", "2.2.2.2", "10.10.0.0/16" ], "items": { "type": "string" }, "nullable": true, "type": "array" }, "ResponseAPIKeyNoSecret": { "properties": { "companyId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "description": { "$ref": "#/components/schemas/APIKeyDescription" }, "id": { "type": "string" }, "key": { "type": "string" }, "status": { "enum": [ "active", "inactive" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "type": "string" }, "whitelistedIPs": { "$ref": "#/components/schemas/WhitelistedIPs" } }, "type": "object" }, "RequestBodyAPIKeyNoSecret": { "properties": { "description": { "$ref": "#/components/schemas/APIKeyDescription" }, "userId": { "type": "string" }, "whitelistedIPs": { "$ref": "#/components/schemas/WhitelistedIPs" } }, "required": [ "userId" ], "type": "object" }, "APIKeyAPIVersion": { "description": "The version of the API this API key is tied to. Must be in the format `YYYY-MM-DD`. For example, `2024-05-22`.\n", "example": "2024-05-22", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "RequestBodyAPIKeyUpdateAPIVersioning": { "properties": { "apiVersion": { "$ref": "#/components/schemas/APIKeyAPIVersion" }, "description": { "$ref": "#/components/schemas/APIKeyDescription" }, "whitelistedIPs": { "$ref": "#/components/schemas/WhitelistedIPs" } }, "type": "object" }, "ResponseAPIKeyNoSecretAPIVersioning": { "properties": { "apiVersion": { "$ref": "#/components/schemas/APIKeyAPIVersion" }, "apiVersionDowngradeNotAllowedAfter": { "description": "A UTC timestamp corresponding to when the API key's version can no longer be downgraded. This timestamp is set to 7 days after the API key's version is updated.\n", "format": "date-time", "type": "string" }, "apiVersionUpdatedAt": { "description": "A UTC timestamp corresponding to when the API key's version was last updated. This timestamp is updated when the API key's version is updated.\n", "format": "date-time", "type": "string" }, "companyId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "description": { "$ref": "#/components/schemas/APIKeyDescription" }, "id": { "type": "string" }, "key": { "type": "string" }, "status": { "enum": [ "active", "inactive" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "type": "string" }, "whitelistedIPs": { "$ref": "#/components/schemas/WhitelistedIPs" } }, "type": "object" }, "FeeApiName": { "description": "The identifier of the dynamic fee configuration for this loan.\nOnly applicable to `type=dynamicFee` fee.\n", "example": "modificationFee", "type": "string" }, "FeeDisplayName": { "description": "The display name of the fee. The display name of the fee is either set by `customDisplayName` (that can be passed in the API)\nor by `displayName` that was configured in the loan type (this is the default value.)\n", "example": "Modification fee", "type": "string" }, "IndexRate": { "description": "The index interest rate for a loan type. The index rate is used in conjunction with an interest rate\non a loan of type `spread` to calculate the effective interest rate for that loan.\n", "properties": { "annualRate": { "description": "The annual interest rate value for the period defined. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate.", "format": "float", "type": "number" }, "country": { "description": "Country. English short name according to\n[ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.\n", "maxLength": 2, "minLength": 2, "type": "string" }, "endDate": { "description": "The index rate end date in the product timezone.\n\nThe end date is inclusive (i.e., the rate is also applied on the end date).\n\nIf set to `null`, the rate is applicable until it changes.\n\nWARNING: If there is no index rate available for a given date, the system will assume\nthat the index rate is 0. It is highly recommended that you set the \"last\" index rate's\nend date to `null`, so that there is always an index rate that is applicable.\n", "format": "date", "nullable": true, "type": "string" }, "externalId": { "$ref": "#/components/schemas/externalId", "description": "The external unique identifier of the index rate." }, "indexDescription": { "description": "The index interest rate description. For example: \"1 Month LIBOR Rate\" or \"Custom rate\".\n", "type": "string" }, "startDate": { "description": "The start date of the index rate in the product timezone.\n\nThe start date is inclusive (i.e., the rate is applied on the start date).\n\nWhen a new Index Interest Rate value is added, the previous rate\n(if it exists) will have its end date set to one calendar day before\nthe new rate's start date.\n\nIf the new rate's start date is in the past, the Peach system will replay all\n\"active\" loans with the new Index Interest Rate value and re-accrue loans' interest.\n(To clarify, it applied to the \"active\" loans at the time of\nIndex Interest Rate addition.)\n\nWARNING: Replaying the entire portfolio of loans might take a long time.\nIt is recommended that you set the new Index Interest Rate at night.\n", "format": "date", "type": "string" } }, "required": [ "annualRate", "startDate" ], "type": "object" }, "IndexRateResult": { "allOf": [ { "properties": { "id": { "description": "The index rate's unique identifier.", "readOnly": true, "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/IndexRate" } ] }, "IndexRatePaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/IndexRateResult" }, "type": "array" } }, "type": "object" } ] }, "IndexRateUpdate": { "properties": { "annualRate": { "description": "The annual interest rate value for the period defined. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate.", "format": "float", "type": "number" }, "endDate": { "description": "The index rate end date in the product timezone. The end date is inclusive. Pass `null` if you do not know when the rate will expire. If\n`null`, the rate is applicable until it changes.\n", "format": "date", "nullable": true, "type": "string" }, "indexDescription": { "description": "The index interest rate description. For example: \"1 Month LIBOR Rate\" or \"Custom rate\".\n", "type": "string" } }, "type": "object" }, "LoansPaging": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "allOf": [ { "$ref": "#/components/schemas/Loan" }, { "properties": { "mainBorrowerExternalId": { "description": "The external identifier of the main borrower of the loan.", "type": "string" }, "newInterestTimestampStartedAt": { "description": "The timestamp of when the new interest timestamp started.", "format": "date-time", "nullable": true, "type": "string" } }, "type": "object" } ] }, "type": "array" } }, "type": "object" } ], "title": "loans" }, "LoansMinimalPaging": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "properties": { "externalId": { "description": "The external identifier of the loan.", "type": "string" }, "id": { "type": "string" }, "loanTypeId": { "description": "The loan type identifier. This is created specifically for each lender's loan product by Peach.", "type": "string" }, "lockStatus": { "description": "Is the loan locked for replay?\n", "type": "boolean" }, "mainBorrowerExternalId": { "description": "The external identifier of the main borrower of the loan.", "type": "string" }, "mainBorrowerId": { "description": "The identifier of the main borrower of the loan.", "type": "string" }, "migrationStatus": { "default": "nonMigrated", "description": "The loan migration status. This attribute can be updated by the Peach system only.\n\n - `nonMigrated` - this is a non-migrated loan. Most loans are expected to be `nonMigrated`.\n - `prepMigration` - the lender can add objects to the loan in the past.\n - `migrating` - the system is migrating the loan. Objects cannot be modified or added.\n - `completed` - the loan was successfully migrated. After a successful migration the loan status will be changed to one of the following statuses: `active`, `accelerated`, `chargedOff` or `paidOff`.\n - `failed` - the loan migration attempt failed. The loan will remain in the `pending` status. You can update the loan details and try to migrate again by calling `Migrate loan` endpoint.\n", "enum": [ "nonMigrated", "prepMigration", "migrating", "completed", "failed" ], "type": "string" }, "newInterestTimestampStartedAt": { "description": "The timestamp of when the new interest timestamp started.", "format": "date-time", "nullable": true, "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } ] }, "NotificationType": { "allOf": [ { "$ref": "#/components/schemas/VersionedMixin" }, { "properties": { "channel": { "allOf": [ { "nullable": true, "type": "string" }, { "$ref": "#/components/schemas/InteractionChannel" } ] }, "delay": { "description": "Length of time after a triggering condition to wait before sending notification.\n", "nullable": true, "type": "integer" }, "onCondition": { "$ref": "#/components/schemas/onCondition" }, "onOutcome": { "$ref": "#/components/schemas/ProcessOutcome" }, "onStatus": { "$ref": "#/components/schemas/ProcessStatus" }, "templateId": { "description": "Communication template identifier to create and send notification.\n", "nullable": true, "type": "integer" }, "theme": { "allOf": [ { "nullable": true, "type": "string" }, { "$ref": "#/components/schemas/InteractionTheme" } ] }, "unit": { "description": "Time units for setting the `delay` time.\n", "enum": [ "calendarDays", "businessDays" ], "nullable": true, "type": "string" } }, "type": "object" } ], "title": "notificationHandler" }, "PaymentProcessorFundingInstrument": { "properties": { "id": { "type": "string" }, "status": { "description": "Status of the funding instrument.\n- `active` - the instrument can be used for reconciliation payments.\n- `pending` - the instrument is pending to be verified.\n- `inactive` - the instrument is not active and cannot be used for reconciliation payments.\n", "enum": [ "active", "inactive", "pending" ], "type": "string" } }, "type": "object" }, "PaymentProcessorMutableFields": { "allOf": [ { "$ref": "#/components/schemas/BaseWithExternalIdMixin" }, { "properties": { "achBatchHeaderCompanyId": { "description": "Data element that is part of the batch header record. For example: `2837461011`.\n", "type": "string" }, "achBatchHeaderCompanyName": { "description": "Data element that is part of the batch header record. For example: `PEACH FIN ACH`.\n", "type": "string" }, "achBatchHeaderOriginatingDFIId": { "description": "Data element that is part of the batch header record. For example: `12773923`.\n\nIf the value is NOT provided (aka null or empty) as part of the configuration, the system will automatically set this value to `achFileHeaderImmediateDestination` without the last digits.\nFor example: if `achFileHeaderImmediateDestination=121140399`, the system will set `achBatchHeaderOriginatingDFIId=12114039`.\n", "type": "string" }, "achCutoff": { "description": "The cutoff time for ACH processing, in the payment processor's timezone. Use 24-hour format. For example: \"19:00\"\n", "format": "time", "type": "string" }, "achFeeAmount": { "description": "The fee charged by the payment processor for regular ACH transactions. For example: 0.05\n", "format": "float", "type": "number" }, "achFeeType": { "description": "How the fee is charged by the payment processor. If the full amount is transferred, and fees are charged monthly, use `gross`.\nIf fees are deducted from the amount transferred, use `net`.\n", "enum": [ "gross", "net" ], "type": "string" }, "achFileHeaderImmediateDestination": { "description": "Data element that is part of the file header record. For example: `121140399`.\n", "type": "string" }, "achFileHeaderImmediateDestinationName": { "description": "Data element that is part of the file header record. For example: `SILICON VALLEY BANK`.\n", "type": "string" }, "achFileHeaderImmediateOrigin": { "description": "Data element that is part of the file header record. For example: `1456726789`.\n", "type": "string" }, "achFileHeaderImmediateOriginName": { "description": "Data element that is part of the file header record. For example: `PEACH FINANCE INC`.\n", "type": "string" }, "achSECCode": { "default": "PPD", "description": "The Standard Entry Class Code within ACH.\n", "enum": [ "CCD", "PPD", "WEB" ], "type": "string" }, "achSameDayCutoff": { "description": "The cutoff time for ACH same day processing, in the payment processor's timezone. Use 24-hour format. For example: \"10:00\"\n", "format": "time", "type": "string" }, "achSameDayFeeAmount": { "description": "The fee charged by the payment processor for same day ACH transactions. For example: 0.50\n", "format": "float", "type": "number" }, "encryptionMethodIncoming": { "description": "The encryption method that Peach system will use to decrypt the incoming files to Peach.\nMake sure you use `peachPublicKey` to encrypt the files sent to Peach or uploaded to SFTP for Peach. Keep the value empty if no encryption is needed.\n", "enum": [ "GPG" ], "nullable": true, "type": "string" }, "encryptionMethodOutgoing": { "description": "The encryption method that Peach system will use to encrypt the outgoing files from Peach. Keep the value empty if no encryption is needed.\nIf `encryptionMethodOutgoing` is set, a value must be set for `thirdPartyPublicKey`.\n", "enum": [ "GPG" ], "nullable": true, "type": "string" }, "isDefault": { "default": false, "description": "Mark the payment processor as default for the company. Only one payment processor can be default. If a new payment processor is created\nwith `isDefault=true` and there is another payment processor with `isDefault=true`, the system will set `isDefault=false` for the\nother/existing processor.\n", "type": "boolean" }, "isFileNameDefaultConvention": { "default": true, "description": "- If `true`, files (e.g. ACH) will be named based on the `ACHP_MMDDYYYYHHMM` convention. For example: `ACHP_110320211305`.\n- If `false`, files (e.g. ACH) will be named based on a custom implementation. Do not set `false` unless you've coordinated with the Peach team.\n", "type": "boolean" }, "peachPublicKey": { "description": "Peach's public key to encrypt the incoming files to Peach.\n", "readOnly": true, "type": "string" }, "privateKeyExpires": { "default": false, "description": "- Only applicable when `signOutgoing` is `true`. Setting this to `true` when `signOutgoing` is `false` will return an error.\n- If true, the private key generated for signing outgoing files will have an expiration date of 2 years from the time of generation.\n- If false (default), the private key does not expire.\n", "type": "boolean" }, "processorName": { "description": "The name of the payment processor. For example: Silicon Valley Bank or Wells Fargo.\n", "type": "string" }, "sftpAccessMethod": { "default": "usernamePassword", "description": "The method used to access the `sftpHostname`.\n- If `usernamePassword`, then `sftpUsername` and `sftpPassword` must be provided.\n- If `keys`, then `sftpSSHPeachPrivateKey` and `sftpSSHPeachPublicKey` will be created by peach.\n", "enum": [ "usernamePassword", "keys", "disabled" ], "type": "string" }, "sftpAchConfirmationFileNameRegex": { "description": "The name of the ACH confirmation file. The format is a regular expression.\nIf you are not sure how to set up the regular expression, please contact the Peach team by providing a few examples of file names.\n\nIf the value is null, we assume that the processor doesn't support ACH confirmation files and any upload of an ACH file is considered as successful.\n", "nullable": true, "type": "string" }, "sftpAchReturnFileNameRegex": { "description": "The name of the ACH return file. The format is a regular expression.\nIf you are not sure how to set up the regular expression, please contact the Peach team by providing a few examples of file names.\n", "type": "string" }, "sftpCdDirInbox": { "description": "The folder where files (e.g. ACH returns) will be downloaded from. The system will change directory into this folder before\nperforming the download.\n", "type": "string" }, "sftpCdDirOutbox": { "description": "The folder where files (e.g. ACH instructions) will be uploaded. The system will change directory into this folder before\nperforming the upload.\n", "type": "string" }, "sftpHostname": { "description": "The hostname for SFTP. Host name should not contain a scheme, so don't put `sftp://` on the front. You may optionally specify a port\nlike so: `example.com:222`. If no port is supplied a default of 22 will be used.\n", "pattern": "^[^/]+$", "type": "string" }, "sftpPassword": { "description": "The password for SFTP.", "nullable": true, "type": "string", "writeOnly": true }, "sftpSSHDisabledAlgorithms": { "description": "A json object of any algorithms that need to be disabled when accessing `sftpHostname` with a private key. This should be null in most scenarios.", "nullable": true, "type": "object" }, "sftpSSHPeachPublicKey": { "description": "Peach public key to used to log into sftpHostname.\n", "readOnly": true, "type": "string" }, "sftpUsername": { "description": "The username for SFTP.", "nullable": true, "type": "string" }, "signOutgoing": { "default": false, "description": "- If true, outgoing files will be encrypted with `thirdPartyPublicKey` and signed with peach's private key. Make sure to set `encryptionMethodOutgoing` and `thirdPartyPublicKey` values.\n- If false, outgoing files will not be signed with peach's private key.\n", "type": "boolean" }, "status": { "description": "The status of the payment processor.\n - `draft` - the payment processor is in the process of being configured and not ready to be used.\n - `active` - the payment processor is ready to process payments.\n - `deprecated` - the payment processor was deprecated, and new payments cannot be processed.\n", "enum": [ "draft", "active", "deprecated" ], "type": "string" }, "thirdPartyPublicKey": { "description": "The third party's (e.g. lender or bank) public key to use to encrypt the outgoing files from Peach. A value must be passed if `encryptionMethodOutgoing` is set.\n", "nullable": true, "type": "string", "writeOnly": true }, "timezone": { "description": "The timezone used by this payment processor. For example: \"America/Los_Angeles\"\n", "type": "string" } }, "type": "object" } ] }, "PaymentProcessor": { "allOf": [ { "properties": { "fundingInstruments": { "description": "The funding instruments that are associated with the payment processor.", "items": { "$ref": "#/components/schemas/PaymentProcessorFundingInstrument" }, "readOnly": true, "type": "array" }, "paymentTypes": { "description": "The payment types that will be processed by the payment processor. Currently, `ach` is supported only.", "items": { "enum": [ "ach", "debitCard", "creditCard" ], "type": "string" }, "type": "array" }, "processorType": { "description": "The type of payment processor.\n- `achDirectUS` - Peach system will create NACHA files and upload directly to lender's bank SFTP.\n", "enum": [ "achDirectUS" ], "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/PaymentProcessorMutableFields" } ], "required": [ "paymentTypes", "processorType", "processorName", "status", "timezone", "sftpAchReturnFileNameRegex", "sftpAccessMethod" ], "title": "Payment Processor" }, "PaymentProcessorUpdateRequest": { "allOf": [ { "properties": { "updatePeachKeys": { "default": false, "description": "- If true, the peach keys for encrypting and decrypting incoming files to Peach are updated. The new `peachPublicKey` value is returned.\n- If false, the peach encryption keys are not changed\n", "type": "boolean", "writeOnly": true } }, "type": "object" }, { "$ref": "#/components/schemas/PaymentProcessorMutableFields" } ] }, "BorrowerPaging": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Borrower" }, "type": "array" } }, "type": "object" } ] }, "PersonSearchPaging": { "allOf": [ { "properties": { "data": { "items": { "$ref": "#/components/schemas/Person" }, "type": "array" }, "search": { "properties": { "maxScore": { "description": "Number representing the maximum scoring result in the results.\n", "format": "float", "type": "number" }, "scores": { "description": "Object mapping result ID's to their score in the search results.\n", "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "BorrowerNoIdentity": { "anyOf": [ { "$ref": "#/components/schemas/PersonNoIdentity" }, { "$ref": "#/components/schemas/BusinessNoIdentity" } ] }, "CanInteractCommonProps": { "description": "The common parameters of a request to determine whether the interaction is\nallowed based on the history of interactions with a borrower and the\nassociated cases.\n\nEither a `theme` or `subject` is required.\n", "properties": { "channel": { "$ref": "#/components/schemas/InteractionChannel" }, "checkAtCompanyNoon": { "description": "If `true`, do time-based checks based on noon today, instead of\nnow. This does not override other reasons a check can fail: the borrower\nhaving a Do Not Interact in place, having reached the interaction\nfrequency limit, etc. This is useful for generating borrower campaigns\nin the morning to be carried out during business hours.\n\nWhere possible, it's always better to check permission right before an\naction. Many things can change (payments are made, other automated\ninteractions are sent, consents/addresses can be updated) from when you\nplan something to happen to when it actually happens. Lenders are\nresponsible for ensuring it is still permissible to conduct the\ninteraction.\n", "type": "boolean" }, "isAutodialed": { "default": false, "description": "`true` if an interaction is prerecorded or autodialed call. This attribute\nis relevant when channel=`voice`. If no value is passed, we'll assume\nisAutodialed=`false` (meaning manual call). If isAutodialed=`true` and\nthe contact's consentAutodialedCall=`false` we'll return result=`false`.\nFor more information read Telephone Consumer Protection Act (TCPA).\n", "nullable": true, "type": "boolean" }, "loanId": { "$ref": "#/components/schemas/AssociatedLoanId" }, "loanIds": { "$ref": "#/components/schemas/AssociatedLoanIds" }, "loansFromCollCase": { "$ref": "#/components/schemas/LoansFromCollCase" }, "subject": { "$ref": "#/components/schemas/InteractionSubject" }, "theme": { "$ref": "#/components/schemas/InteractionTheme" } }, "required": [ "channel" ], "type": "object" }, "CanInteractByContactIdentifier": { "allOf": [ { "$ref": "#/components/schemas/CanInteractCommonProps" }, { "properties": { "contactExternalId": { "description": "The lender's identifier of the contact information.\n", "type": "string", "writeOnly": true }, "contactId": { "description": "An identifier of an existing contact.\n", "type": "string" } }, "required": [ "contactId" ], "type": "object" } ], "title": "canInteractByContactId" }, "InteractionCanInteractResult": { "properties": { "result": { "type": "boolean" } }, "type": "object" }, "DoNotInteractEndDate": { "description": "A future date when interaction restrictions will be lifted.\nThe value format is date only, without time. If today is `endDate`, the\nrestriction will remain until the end of day in the product timezone.\nIf no value is provided, `doNotInteract` will remain in effect until\n`Remove do not interact` is called or `endDate` is set to a date in the past.\n", "format": "date", "nullable": true, "type": "string" }, "schemas-TimeOfDay": { "properties": { "fromHour": { "description": "From hour in the borrower's home address timezone. Value range is 0-23. 0=Midnight...23=11 PM.\n`fromHour` must be smaller than `toHour`.\n", "format": "int32", "type": "number" }, "toHour": { "description": "To hour in the borrower's home address timezone. Value range is 0-23. 0=Midnight...24=Midnight of following day.\n`fromHour` must be smaller than `toHour`.\n", "format": "int32", "type": "number" } }, "required": [ "fromHour", "toHour" ], "type": "object" }, "DoNotInteractUpdate": { "description": "Update the Do Not Interact.\n\nThe only data that can be updated after creation of a `doNoInteract` are external reference and\nthe ending date.\n", "properties": { "caseId": { "description": "Identifier of the case to which the `doNotInteract` belongs.", "readOnly": true, "type": "string" }, "channels": { "description": "Channel(s) for which outbound interactions with a borrower are blocked.\nUse value `all` for all channels.\n", "items": { "$ref": "#/components/schemas/DoNotInteractChannel" }, "type": "array" }, "contactLabels": { "description": "A list of contact labels.\nA person's mobile phone is labeled as `personal`.\nA person's work phone is labeled as `work`.\nA person's home phone is labeled as `home`.\nA person's home address is labeled as `home`.\n", "items": { "$ref": "#/components/schemas/ContactLabel" }, "type": "array" }, "daysOfWeek": { "description": "A list of days of week at which to block. \n\nValid range is 1-7. 1=Monday...7=Sunday. For example: `[1, 2, 4]`.\n\n- If the day of week matches *any* of the values specified here, then the interaction is blocked.\n- If this array is empty, then the interaction is blocked for all days of week.\n", "example": [ 1, 2, 4 ], "items": { "format": "int32", "type": "number" }, "type": "array" }, "endDate": { "$ref": "#/components/schemas/DoNotInteractEndDate" }, "object": { "default": "doNotInteract", "enum": [ "doNotInteract" ], "readOnly": true, "type": "string" }, "personId": { "description": "Identifier of the borrower to which the `doNotInteract` belongs.", "readOnly": true, "type": "string" }, "source": { "default": "service", "description": "How the `DoNotInteract` instance was created. This is used by the internal case processing to determine\nwhether to stop blocking interactions when the `Case` changes state. This may not be returned by\ndefault depending on your configuration.\n\nThe possible values are:\n\n* `api`: created by an external user through an authorized HTTP request to the API\n* `service`: created by internal server process, or an API call from a recognized Peach service within the\nvirtual private cloud (VPC)\n* `manual`: created by SQL or manual entry, this is prevented except for rare maintenance situations.\n", "enum": [ "api", "service", "manual" ], "readOnly": true, "type": "string" }, "themes": { "description": "Theme(s) for which outbound interactions with a borrower are blocked. Use value\n`all` for all themes. `all` doesn't include `opsAccountCredentials`.\nFor example, use `opsCollDebt` to stop debt collection interactions.\n", "items": { "$ref": "#/components/schemas/DoNotInteractTheme" }, "type": "array" }, "timesOfDay": { "description": "A list of times of day at which to block—in hour resolution.\n\n- If the time falls into *any* of the ranges specified here, then\nthe interaction is blocked.\n- If this array is empty, then the interaction is blocked for all times of day.\n", "items": { "$ref": "#/components/schemas/schemas-TimeOfDay" }, "type": "array" }, "timezone": { "description": "The time zone where the borrower is located. If provided, the time zone will be used for restriction. If not provided, the system will use the borrower's home address time zone.\n", "type": "string" } }, "title": "doNotInteract", "type": "object" }, "DoNotInteract": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "$ref": "#/components/schemas/DoNotInteractUpdate" }, { "description": "Channel(s) and theme(s) for which interactions with a borrower are blocked.\nInteractions with theme=`outOpsServicing` cannot be blocked since they\nare typically initiated by a borrower.\n", "properties": { "startDate": { "description": "The start date for blocking interactions with a borrower. The value format is date\nonly, without time. The start date can be a future date.\nIf the value is not provided, or equal to today's date, or a date in the past, then the\n`doNotIteract` will be effective as soon as we process the request.\n", "format": "date", "type": "string" } }, "type": "object" } ], "title": "doNotInteract" }, "ConsentItem": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "name": { "description": "Represents special consents or permissions. Consents are typically\ngiven in writing to a lender.\n\n- `electronicComms` - Set to `revoked` if the borrower hasn't consented or\nhas revoked consent to electronic communications. Default: `consented`\n\n- `contactPersonWork` - A borrower or their attorney gave a written\nconsent to contact borrower's employer for debt collection. Default: `revoked`\n\n- `contactPersonRepByAttorney` - Indicates whether a lender is\nallowed to contact a borrower represented by an attorney. If the attorney\ngave a written consent to interact with the borrower, set\nto `consented`. Default: `revoked`\n\n- `contactPersonUnusualTime` - A person or their attorney gave\nwritten consent to interact with the person at some unusual\nplace or time. Default: `revoked`\n\n- `autodialedColl` - Consent to receive autodialed or pre-recorded\ncollection calls from creditors or third-party collectors. If no\nvalue is provided, we will assume autodialedColl is `consented`. For\nmore information read Telephone Consumer Protection Act (TCPA).\nDefault: `consented`\n\n- `executeWageAssignment` - Set to `consented` if the person consented to\nexecute a wage assignment agreement. Default: `revoked`\n\n- `contactServicememberUnitOrCommander` - Consent to contact a\nservicemember's military unit or chain of command to collect on a debt. Default: `revoked`.\n", "enum": [ "electronicComms", "contactPersonWork", "contactPersonRepByAttorney", "contactPersonUnusualTime", "autodialedColl", "executeWageAssignment", "contactServicememberUnitCollDebt" ], "type": "string" }, "object": { "default": "consent", "enum": [ "consent" ], "readOnly": true, "type": "string" }, "value": { "description": "Consent can be granted and revoked by a borrower.\n", "enum": [ "consented", "revoked" ], "type": "string" } }, "required": [ "name", "value" ], "type": "object" } ], "title": "consent" }, "Consents": { "items": { "$ref": "#/components/schemas/ConsentItem" }, "type": "array" }, "ConsentArray": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "$ref": "#/components/schemas/Consents" } }, "type": "object" } ], "title": "consent" }, "DocumentUploadLink": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "caseId": { "description": "The identifier of the case associated with the doc upload link", "nullable": true, "type": "string" }, "contactId": { "description": "The identifier of the contact to which the doc upload link will be sent", "type": "string" } }, "type": "object" } ] }, "DocumentDescriptorUpdate": { "allOf": [ { "$ref": "#/components/schemas/BaseWithExternalIdMixin" }, { "$ref": "#/components/schemas/DocumentDescriptorFields" }, { "properties": { "type": { "$ref": "#/components/schemas/DocumentType" } }, "type": "object" } ] }, "IdentityPaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Identity" }, "type": "array" } }, "type": "object" } ] }, "LegalRepresentative": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "description": "Contains details about an entity that legally represents a borrower.\n", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "email": { "description": "The email address of a legal entity.", "type": "string" }, "name": { "$ref": "#/components/schemas/Name" }, "object": { "default": "legalRepresentative", "enum": [ "legalRepresentative" ], "readOnly": true, "type": "string" }, "otherEmail": { "description": "An additional email address of a legal entity.", "type": "string" }, "otherPhone": { "description": "An additional phone number of a legal entity. This should be provided in\n[E.164](https://en.wikipedia.org/wiki/E.164) format.\n", "type": "string" }, "phone": { "description": "The phone number of a legal entity. This should be provided in\n[E.164](https://en.wikipedia.org/wiki/E.164) format.\n", "type": "string" }, "status": { "description": "Legal representative's status.", "enum": [ "active", "nonResponsive", "inactive", "archived" ], "type": "string" }, "statusUpdatedAt": { "description": "The time of status update.", "format": "date-time", "readOnly": true, "type": "string" }, "validAddress": { "$ref": "#/components/schemas/ValidAddress" } }, "type": "object" } ], "title": "legalRepresentative" }, "LegalRepresentativesPaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "description": "Array of legal entities\n", "items": { "$ref": "#/components/schemas/LegalRepresentative" }, "type": "array" } }, "type": "object" } ], "title": "legalRepresentative" }, "NewInstallmentAtOriginationRequirements": { "properties": { "atOrigination": { "required": [ "amountFinanced", "duration", "interestRates", "paymentFrequency", "originationLicense", "originatingCreditorName" ], "type": "object" } }, "type": "object" }, "NewInstallment": { "allOf": [ { "properties": { "timestamps": { "description": "**DEPRECATED** The fields in this object will not affect the loan.\n" }, "type": { "enum": [ "installment" ], "type": "string" } }, "required": [ "loanTypeId", "servicedBy", "status" ], "type": "object" }, { "$ref": "#/components/schemas/Installment" }, { "$ref": "#/components/schemas/NewInstallmentAtOriginationRequirements" } ], "title": "Installment" }, "NewLineOfCreditAtOriginationRequirements": { "properties": { "atOrigination": { "required": [ "creditLimitAmount", "interestRates", "paymentFrequency", "originationLicense", "originatingCreditorName" ], "type": "object" } }, "type": "object" }, "NewLineOfCredit": { "allOf": [ { "properties": { "timestamps": { "description": "**DEPRECATED** The fields in this object will not affect the loan.\n" }, "type": { "enum": [ "lineOfCredit" ], "type": "string" } }, "required": [ "loanTypeId", "servicedBy", "status" ], "type": "object" }, { "$ref": "#/components/schemas/LineOfCredit" }, { "$ref": "#/components/schemas/NewLineOfCreditAtOriginationRequirements" } ], "title": "Line of Credit" }, "NewLoan": { "anyOf": [ { "$ref": "#/components/schemas/NewInstallment" }, { "$ref": "#/components/schemas/NewLineOfCredit" } ], "description": "Represents a loan. A loan always belongs to a borrower, and most of\nthe interactions between a lender and a borrower are associated with a\nparticular loan.\n", "title": "newLoan" }, "LoanAccelerate": { "allOf": [ { "properties": { "effectiveDate": { "description": "The effective date of the loan acceleration. The date should be the current date in the product timezone.\nPassing in `\"today\"` will also set the field to today's date.\n", "format": "date", "type": "string" }, "sendNotice": { "default": true, "description": "When set to `false`, the system will NOT send a `loanAccelerated` notice to the borrower.", "type": "boolean" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ], "required": [ "effectiveDate" ] }, "LoanAccelerateResponse": { "properties": { "acceleratedAmount": { "description": "The amount accelerated.", "format": "float", "type": "number" } }, "type": "object" }, "LoanActivate": { "properties": { "amortizationAtActivation": { "description": "Instructions on how to activate a loan in `originated` status. The loan status\nchanges to `active` after a successful activation.\n\n`expectedPaymentsAtOrigination` - we will use the exact `atOrigination.expectedPayments`\ndue dates and amounts. The loan is not re-amortized.\n\n`amortizeAtActivation` - we will re-amortize the loan using today's date as the loan start date.\n`atOrigination.paymentFrequency` and `atOrigination.specificDays` are used to create due dates.\n`atOrigination.expectedPayments` due dates and amounts are not used.\n", "enum": [ "expectedPaymentsAtOrigination", "amortizeAtActivation" ], "type": "string" }, "sendNotice": { "default": true, "description": "When set to `false`, the system will NOT send a `loanDetails` notice to the borrower.", "type": "boolean" } }, "type": "object" }, "ExpectedPayment": { "properties": { "amount": { "description": "The amount of the expected payment.", "format": "float", "type": "number" }, "date": { "description": "The due date of the expected payment.", "format": "date", "type": "string" }, "dynamicFeeDetails": { "description": "When `paymentType`=`dynamicFee` this will contain details of the dynamic fee.\n", "properties": { "apiName": { "description": "The API name of the dynamic fee. For example: 'lateFee' or 'breatherFee'.\n", "type": "string" }, "displayName": { "description": "The display name of the dynamic fee as shown to the borrower in the UI. For example: `Late Fee` or `Breather Fee`.\n", "type": "string" }, "dynamicFeeTypeId": { "description": "The dynamic fee type identifier in the system.", "type": "string" }, "loanFeeId": { "description": "The loan fee identifier in the system.", "type": "string" } }, "type": "object" }, "interestAmount": { "description": "The portion of the `amount` allocated to net interest.\nAvailable only for `paymentType=periodicPayment`.\n", "format": "float", "type": "number" }, "interestBeforeDiscountAmount": { "description": "The interest amount that was accrued before promo rate(s) or any discount.\nAvailable only for `paymentType=periodicPayment`.\n", "format": "float", "type": "number" }, "isDeferred": { "description": "`true` if the amount of this expected payment has been deferred before.\n", "readOnly": true, "type": "boolean" }, "isForcedAmount": { "description": "Only applicable to `paymentType=periodicPayment`.\nIf set to `true`, the system will honor the amount and will not update it on loan recalculations.\nIf set to `false` and the amount is less than the `periodicPaymentAmount`, the system can increase the amount when\nthe loan is being recalculated.\nIn most of the cases, the lender should set the value to `false` (aka the default value.) If you need more\nexplanation or advice on your use case, please contact the Peach team.\n", "readOnly": true, "type": "boolean" }, "originalAmount": { "description": "The amount of the expected payment at creation. The `amount` will change as a result of refreshing\nexpected payments, but the `originalAmount` will stay the same.\n", "format": "float", "type": "number" }, "paymentType": { "description": "The payment type.", "enum": [ "periodicPayment", "originationFee", "drawFee", "dynamicFee", "downPayment", "discountCredit" ], "type": "string" }, "periodId": { "description": "The period identifier.", "type": "string" }, "principalAmount": { "description": "The portion of the `amount` allocated to principal.\nAvailable only for `paymentType=periodicPayment`.\n", "format": "float", "type": "number" }, "status": { "description": "The status of the expected payment.\n\n`scheduled` - borrower is expected to make the payment. Only applicable to paymentType=dynamicFee.\n\n`booked` - borrower is or was expected to make the payment.\n\n`modified` - the amount was modified at some point and different from the original amount.\n\n`canceled` - borrower is or was not expected to make the payment.\n", "enum": [ "booked", "modified", "canceled" ], "type": "string" }, "unroundedInterestAmount": { "description": "The portion of the `amount` allocated to net interest. Available only for `paymentType=periodicPayment`.\nThis value is unrounded.\n", "nullable": true, "type": "string" }, "unroundedInterestBeforeDiscountAmount": { "description": "The interest amount that was accrued before promo rate(s) or any discount. Available only for\n`paymentType=periodicPayment`. This value is unrounded.\n", "nullable": true, "type": "string" }, "unroundedPrincipalAmount": { "description": "The portion of the `amount` allocated to principal. Available only for `paymentType=periodicPayment`.\nThis value is unrounded.\n", "nullable": true, "type": "string" } }, "type": "object" }, "LoanSchedule": { "properties": { "schedule": { "items": { "$ref": "#/components/schemas/ExpectedPayment" }, "type": "array" } }, "type": "object" }, "LoanActivationResponse": { "oneOf": [ { "properties": { "amountsValidation": { "$ref": "#/components/schemas/AmountsValidation" }, "ratesValidation": { "$ref": "#/components/schemas/RatesValidation" }, "schedule": { "$ref": "#/components/schemas/LoanSchedule" } }, "title": "Installment", "type": "object" }, { "properties": { "amountsValidation": { "$ref": "#/components/schemas/AmountsValidation" }, "schedule": { "$ref": "#/components/schemas/LoanSchedule" } }, "title": "Line of Credit", "type": "object" } ] }, "AutopayExpectedPayment": { "properties": { "amount": { "description": "The amount of the expected payment.", "format": "float", "type": "number" }, "date": { "description": "The due date of the expected payment.", "format": "date", "type": "string" }, "dynamicFeeDetails": { "description": "When `paymentType`=`dynamicFee` this will contain details of the dynamic fee.\n", "properties": { "apiName": { "description": "The API name of the dynamic fee. For example: 'lateFee' or 'breatherFee'.\n", "type": "string" }, "displayName": { "description": "The display name of the dynamic fee as shown to the borrower in the UI. For example: `Late Fee` or `Breather Fee`.\n", "type": "string" }, "dynamicFeeTypeId": { "description": "The dynamic fee type identifier in the system.", "type": "string" }, "loanFeeId": { "description": "The loan fee identifier in the system.", "type": "string" } }, "type": "object" }, "interestAmount": { "description": "The portion of the `amount` allocated to net interest.\nAvailable only for `paymentType=periodicPayment`.\n", "format": "float", "type": "number" }, "interestBeforeDiscountAmount": { "description": "The interest amount that was accrued before promo rate(s) or any discount.\nAvailable only for `paymentType=periodicPayment`.\n", "format": "float", "type": "number" }, "isDeferred": { "description": "`true` if the amount of this expected payment has been deferred before.\n", "readOnly": true, "type": "boolean" }, "originalAmount": { "description": "The amount of the expected payment at creation. The `amount` will change as a result of refreshing\nexpected payments, but the `originalAmount` will stay the same.\n", "format": "float", "type": "number" }, "paymentType": { "description": "The payment type.", "enum": [ "periodicPayment", "originationFee", "drawFee", "dynamicFee", "downPayment", "discountCredit" ], "type": "string" }, "periodId": { "description": "The period identifier.", "type": "string" }, "principalAmount": { "description": "The portion of the `amount` allocated to principal.\nAvailable only for `paymentType=periodicPayment`.\n", "format": "float", "type": "number" }, "status": { "description": "The status of the expected payment.\n\n`booked` - borrower is or was expected to make the payment.\n\n`modified` - the amount was modified at some point and different from the original amount.\n\n`canceled` - borrower is or was not expected to make the payment.\n\n`processed` - a payment has been scheduled for this expected payment.\n", "enum": [ "booked", "modified", "canceled", "processed" ], "type": "string" } }, "type": "object" }, "InstallmentAutopay": { "allOf": [ { "$ref": "#/components/schemas/IsLocked" }, { "properties": { "agreementDocumentId": { "description": "The document descriptor ID corresponding to the autopay agreement document.\n", "type": "string" }, "cancelReason": { "$ref": "#/components/schemas/AutopayCancelReason" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "description": "The autopay identifier.", "readOnly": true, "type": "string" }, "paymentFrequency": { "description": "The Autopay payments frequency.", "enum": [ "weekly", "everyTwoWeeks", "twiceMonthly", "monthly" ], "type": "string" }, "paymentInstrumentId": { "description": "The payment instrument ID with which this autopay plan will be charged through.\n", "type": "string" }, "schedule": { "items": { "$ref": "#/components/schemas/AutopayExpectedPayment" }, "type": "array" }, "specificDays": { "$ref": "#/components/schemas/SpecificDays" } }, "type": "object" } ], "title": "Installment" }, "LineOfCreditAutopay": { "allOf": [ { "$ref": "#/components/schemas/IsLocked" }, { "properties": { "agreementDocumentId": { "description": "The document descriptor ID corresponding to the autopay agreement document.\n", "type": "string" }, "cancelReason": { "description": "Why the transaction was canceled.", "enum": [ "invalidPaymentMethod", "paymentMethodRemoved", "tooManyFailedAttempts", "loanFrozen", "loanAccelerated", "loanChargedOff", "loanPaidOff", "canceledByUser", "loanTermsChanged" ], "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "extraAmount": { "description": "The extra amount that the borrower agrees to pay if `type=statementMinimumAmountPlusExtra`.", "format": "float", "type": "number" }, "id": { "description": "The autopay identifier.", "readOnly": true, "type": "string" }, "isAlignedToDueDates": { "description": "`true` - the Autopay transactions will be processed on the loan's due dates.\n\n`false` - the Autopay transactions schedule will be different from the loan's due dates schedule.\n\nIf `isAlignedToDueDates=false` then `paymentFrequency` and `specificDays` must be provided.\n", "type": "boolean" }, "offsetFromDueDate": { "items": { "type": "integer" }, "nullable": true, "type": "array" }, "paymentFrequency": { "description": "The Autopay payments frequency. `Weekly` frequency is not supported for line of credit.", "enum": [ "twiceMonthly", "everyTwoWeeks", "monthly" ], "type": "string" }, "paymentInstrumentId": { "description": "The payment instrument ID with which this autopay plan will be charged through.\n", "type": "string" }, "schedule": { "items": { "$ref": "#/components/schemas/AutopayExpectedPayment" }, "type": "array" }, "specificDays": { "$ref": "#/components/schemas/SpecificDays" }, "type": { "description": "Indicates how Autopay amount will be calculated for each closed statement.\n\n`statementMinimumAmount` - an Autopay will debit the statement minimum amount for the period.\n\n`statementMinimumAmountPlusExtra` - an Autopay will debit the statement minimum amount for the period plus\nextra amount. The extra amount is typically applied to principal. This is ONLY applicable to non-amortized\nline of credit loans.\n\n`statementBalanceAmount` - an Autopay transaction will debit the statement balance for the period. This is ONLY applicable to non-amortized\nline of credit loans.\n", "enum": [ "statementMinimumAmount", "statementMinimumAmountPlusExtra", "statementBalanceAmount" ], "type": "string" } }, "type": "object" } ], "title": "Line Of Credit" }, "Autopay": { "anyOf": [ { "$ref": "#/components/schemas/InstallmentAutopay" }, { "$ref": "#/components/schemas/LineOfCreditAutopay" } ] }, "AutopayUpdate": { "properties": { "agreementDocumentId": { "description": "The document ID for the signed autopay agreement. Required if `previewMode=false`.\n", "type": "string" }, "caseId": { "description": "An identifier for an existing case.\n", "type": "string" }, "paymentInstrumentId": { "description": "The payment instrument ID with which this autopay plan will be charged through.\n", "type": "string" }, "sendNotice": { "default": true, "description": "When set to `false`, the system will NOT send a `autopayPaymentMethodUpdated` notice to the borrower.", "type": "boolean" } }, "required": [ "paymentInstrumentId", "agreementDocumentId" ], "type": "object" }, "DeltaTerms": { "description": "The delta change in interest, fees, calendar days, and number of due dates. Only relevant for installment loans. For\nnon installment loans, `deltaTerms` fields will be null.\n", "properties": { "deltaTerms": { "properties": { "deltaDueDatesNumber": { "description": "A positive number indicates the number of additional due dates that were added to the loan schedule. A negative\nnumber indicates the number due dates that were removed from the loan schedule.\n", "nullable": true, "type": "integer" }, "deltaDurationDays": { "description": "A positive number indicates number of calendar days that the loan's term is extended as a result of the\nchange. A negative number indicates the number of calendar days that the loan's term is shortened as\na result of the change.\n", "nullable": true, "type": "integer" }, "deltaFeeAmount": { "description": "A positive amount indicates the additional fees that the borrower is expected to pay as a result of\nthe change. A negative amount indicates savings in fees the borrower is expected to benefit from as\na result of the change.\n", "format": "float", "nullable": true, "type": "number" }, "deltaInterestAmount": { "description": "A positive amount indicates the additional interest that the borrower is expected to pay as a\nresult of the change. A negative amount indicates savings in interest the borrower is expected to\nbenefit from as a result of the change.\n", "format": "float", "nullable": true, "type": "number" } }, "type": "object" } }, "type": "object" }, "InstallmentAutopayPost": { "properties": { "agreementDocumentId": { "description": "The document ID for the signed autopay agreement. Required if `previewMode=false`.\n", "type": "string" }, "caseId": { "description": "An identifier for an existing case.\n", "type": "string" }, "isAlignedToDueDates": { "description": "`true` - the Autopay payments will be aligned and processed on the loan's due dates.\n\n`false` - the Autopay payments schedule will be different from the loan's due dates schedule.\n\nIf `isAlignedToDueDates=false` then `paymentFrequency` and `specificDays` must be provided.\n\nIf the frequency and specific days of autopay matches the loan, we assume that it is `isAlignedToDueDates=true`.\n", "type": "boolean" }, "paymentFrequency": { "description": "The Autopay payments frequency.", "enum": [ "weekly", "everyTwoWeeks", "twiceMonthly", "monthly" ], "type": "string" }, "paymentInstrumentId": { "description": "The payment instrument ID with which this autopay plan will be charged through.\n", "type": "string" }, "previewMode": { "default": false, "description": "In `previewMode=true`, the loan doesn't change, and no changes are saved to the database.", "type": "boolean" }, "sendNotice": { "default": true, "description": "When set to `false`, the system will NOT send a `autopayEnabled` notice to the borrower.", "type": "boolean" }, "specificDays": { "$ref": "#/components/schemas/SpecificDays" } }, "required": [ "paymentInstrumentId" ], "title": "Installment", "type": "object" }, "LineOfCreditAutopayPost": { "properties": { "agreementDocumentId": { "description": "The document ID for the signed autopay agreement. Required if `previewMode=false`.\n", "type": "string" }, "amountType": { "default": "statementMinimumAmount", "description": "Indicates how Autopay amount will be calculated for each closed statement.\n\n`statementMinimumAmount` - an Autopay will debit the statement minimum amount for the period. The statement minimum\namount is defined as the sum of the expected payment amounts in the given period.\n\n`statementMinimumAmountPlusExtra` - an Autopay will debit the statement minimum amount for the period plus\nextra amount. The extra amount is typically applied to principal. In any given autopay period, if the\n'statementMinimumAmountPlusExtra' is greater than the outstanding balance on the line of credit, we only debit\nup to the amount of the latter.\n\n`statementBalanceAmount` - an Autopay transaction will debit the statement balance as of the statement creation\ndate for the given period.\n", "enum": [ "statementMinimumAmount", "statementMinimumAmountPlusExtra", "statementBalanceAmount" ], "type": "string" }, "caseId": { "description": "An identifier for an existing case.\n", "type": "string" }, "extraAmount": { "description": "The extra amount that the borrower agrees to pay if `type=statementMinimumAmountPlusExtra`.", "format": "float", "type": "number" }, "isAlignedToDueDates": { "description": "`true` - the Autopay transactions will be processed on the loan's due dates.\n\n`false` - the Autopay transactions schedule will be different from the loan's due dates schedule.\nIf `isAlignedToDueDates=false` then `offsetFromDueDate` must be provided.\n", "type": "boolean" }, "offsetFromDueDate": { "description": "Number of calendars days before due dates when Autopay payments are processed.\nIf `isAlignedToDueDates` is false, it is required to specify the offset from the due dates. Depending on whether there are 1 or 2 auto-payments\nper period, the array should include either 1 or 2 integers.\n\n - `onceAPeriod` - borrower can choose X days before the due date. Provide one number in a valid range between \"1\" and \"statement to due date\"\n days (e.g. 14 or 21). For example: `[5]` means the Autopay will be processed 5 calendar days before a given due date.\n - `twiceAPeriod` - borrower can choose two offsets, in other words, Autopay will process half the amount on the first Autopay date, and half\n the amount on the second Autopay date. Both days are \"offsets\", with \"0\" meaning on the due date. For example: `[5, 0]` means the first Autopay\n payment will be scheduled and processed 5 days before the due date, and the second Autopay payment will be scheduled and processed on the due date.\n", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "paymentInstrumentId": { "description": "The payment instrument ID with which this autopay plan will be charged through.\n", "type": "string" }, "previewMode": { "default": false, "description": "If `previewMode=true`, the loan doesn't change and no changes are saved to the database.\n", "type": "boolean" }, "sendNotice": { "default": true, "description": "When set to `false`, the system will NOT send a `autopayEnabled` notice to the borrower.", "type": "boolean" } }, "required": [ "paymentInstrumentId" ], "title": "Line Of Credit", "type": "object" }, "AutopayPost": { "anyOf": [ { "$ref": "#/components/schemas/InstallmentAutopayPost" }, { "$ref": "#/components/schemas/LineOfCreditAutopayPost" } ] }, "LoanCancelMetro2RequestBody": { "properties": { "accountStatusCode": { "default": "DA", "description": "The Metro2 Account Status that will be reported to credit agencies upon loan cancellation or deletion. Make sure you follow the Metro2 Credit Reporting Resource Guide.\nThe following statuses were copied from the Metro2 Guide. The list below is a subset of account status codes.\n\n- `13` - Paid or closed account/zero balance. For Installment and Mortgage loans, the account should be paid with a zero Balance Amount. For Credit Line, Open and Revolving portfolio types, the account should no longer be available for use, and the Balance Amount should be zero. A Special Comment Code M or Compliance Condition Code XA may also be reported to indicate the account is closed.\n- `61` - Account paid in full, was a voluntary surrender. Requires Current Balance and Amount Past Due = zero.\n- `62` - Account paid in full, was a collection account. Requires Current Balance and Amount Past Due = zero.\n- `63` - Account paid in full, was a repossession. Requires Current Balance and Amount Past Due = zero.\n- `93` - Account assigned to internal or external collections.\n- `95` - Voluntary surrender; there may be a balance due.\n- `96` - Merchandise was repossessed; there may be a balance due.\n- `97` - Unpaid balance reported as a loss (charge-off).\n- `DA` - Delete entire account (for reasons other than fraud).\n- `DF` - Delete entire account due to confirmed fraud (fraud investigation completed).\n", "enum": [ "13", "61", "62", "63", "93", "95", "96", "97", "DA", "DF" ], "type": "string" } }, "type": "object" }, "LoanCancel": { "allOf": [ { "properties": { "cancellationReason": { "$ref": "#/components/schemas/CancellationReason" }, "metro2": { "$ref": "#/components/schemas/LoanCancelMetro2RequestBody" }, "sendCancellationNotice": { "default": false, "description": "When set to `true`, the system will send `loanCanceled` notice to the borrower.\n", "type": "boolean" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ] }, "CardBaseData": { "allOf": [ { "$ref": "#/components/schemas/BaseWithExternalIdMixin" }, { "properties": { "externalId": { "description": "A lender's unique identifier for a specific promotional program type.", "type": "string" }, "galileoCad": { "description": "Galileo-generated identifier for a specific card.\n", "type": "string" }, "galileoPrn": { "description": "Unique 12-digit Galileo-generated account identifier.\n", "type": "string" }, "issuerId": { "description": "The card issuer/vendor unique identifier. The card issuer must be configured in Peach.", "type": "string" }, "lithicAccountToken": { "description": "Lithic-generated identifier for an account holder (consumer or business).\n", "type": "string" }, "lithicCardToken": { "description": "Lithic-generated identifier for a specific card product.\n", "type": "string" }, "marqetaBusinessToken": { "description": "Marqeta-generated identifier for a specific business.\n", "type": "string" }, "marqetaCardProductToken": { "description": "Marqeta-generated identifier for a specific card product.\n", "type": "string" }, "marqetaCardToken": { "description": "Lender or Marqeta-generated unique identifier for the card.\n", "type": "string" }, "marqetaUserToken": { "description": "Marqeta-generated identifier for a specific user.\n", "type": "string" } }, "type": "object" } ] }, "CardDetails": { "description": "The card details.", "properties": { "address": { "$ref": "#/components/schemas/Address", "description": "The billing address associated with the card. Must have at least postal code." }, "cardNumberLastFour": { "description": "The last four digits of the card number.", "type": "string" }, "expirationMonth": { "description": "The expiration month of the card.", "example": 12, "maximum": 12, "minimum": 1, "type": "integer" }, "expirationYear": { "description": "The expiration year of the card.", "example": 2025, "type": "integer" }, "firstName": { "description": "First name on the card.", "type": "string" }, "fulfillmentStatus": { "description": "The fulfillment status of the card.", "enum": [ "issued", "ordered", "rejected", "shipped", "digitallyPresented" ], "type": "string" }, "lastName": { "description": "Last name on the card.", "type": "string" }, "network": { "description": "The card network.", "enum": [ "visa", "mastercard", "discover", "americanExpress" ], "type": "string" }, "nickname": { "description": "Nickname for card, typically decided by consumer", "nullable": true, "type": "string" }, "status": { "description": "The status of the card.", "enum": [ "inactive", "pendingActivation", "pendingFulfillment", "active", "paused", "suspended", "terminated", "canceled", "expired", "invalid" ], "type": "string" }, "usageType": { "description": "The type of allowable usage for the card.", "enum": [ "singleUse", "merchantLocked", "digitalWallet", "unlocked", "physical" ], "type": "string" } }, "type": "object" }, "BaseCard": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "$ref": "#/components/schemas/CardBaseData" }, { "properties": { "cardDetails": { "$ref": "#/components/schemas/CardDetails" } }, "type": "object" } ], "title": "Card" }, "VirtualCardProperties": { "properties": { "cardBalances": { "description": "The card balances. Only applicable to `virtualCard` type card objects.", "properties": { "originalAmount": { "description": "The original amount of the card before it was used. If null, will default to the loan's `atOrigination.amountFinanced`.\n", "format": "float", "nullable": true, "type": "number" }, "refundedAmount": { "description": "The amount of the card that was refunded back to the card or otherwise not used.\n", "format": "float", "nullable": true, "readOnly": true, "type": "number" }, "usedAmount": { "description": "The amount of the card that was used.\n", "format": "float", "nullable": true, "readOnly": true, "type": "number" } }, "type": "object" }, "type": { "description": "The type of card issued. For loanType `installment`, only the only allowable value is virtualCard.\nFor loanType `lineOfCredit`, virtual and credit card are accepted.\n", "enum": [ "virtualCard" ], "type": "string" } }, "type": "object" }, "VirtualCard": { "allOf": [ { "$ref": "#/components/schemas/BaseCard" }, { "$ref": "#/components/schemas/VirtualCardProperties" } ], "title": "Virtual card" }, "CreditCardProperties": { "properties": { "type": { "description": "The type of card issued. For loanType `installment`, only the only allowable value is virtualCard.\nFor loanType `lineOfCredit`, virtual and credit card are accepted.\n", "enum": [ "creditCard" ], "type": "string" }, "usageRestrictions": { "allOf": [ { "description": "Additional usage restrictions of the specific card to apply to purchases. These will be applied in addition to `usageRestrictions` created in the program object as part of the card issuer APIs.\n" }, { "$ref": "#/components/schemas/UsageRestrictions" } ] } }, "type": "object" }, "CreditCard": { "allOf": [ { "$ref": "#/components/schemas/BaseCard" }, { "$ref": "#/components/schemas/CreditCardProperties" } ], "title": "Credit card" }, "Card": { "anyOf": [ { "$ref": "#/components/schemas/VirtualCard" }, { "$ref": "#/components/schemas/CreditCard" } ] }, "CardDetailsWithPanAndCvv": { "allOf": [ { "$ref": "#/components/schemas/CardDetails" }, { "properties": { "cvvNumber": { "description": "The full CVV2 number. Only included in the `GET` endpoint when `showCvv=true`.", "readOnly": true, "type": "string" }, "pan": { "description": "The card full PAN. Only included in the `GET` endpoint when `showPan=true`.", "type": "string" } }, "type": "object" } ] }, "BaseCardWithPanAndCvv": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "$ref": "#/components/schemas/CardBaseData" }, { "properties": { "cardDetails": { "$ref": "#/components/schemas/CardDetailsWithPanAndCvv" } }, "type": "object" } ], "title": "Card" }, "VirtualCardWithPanAndCvv": { "allOf": [ { "$ref": "#/components/schemas/BaseCardWithPanAndCvv" }, { "$ref": "#/components/schemas/VirtualCardProperties" } ], "title": "Virtual card" }, "CreditCardWithPanAndCvv": { "allOf": [ { "$ref": "#/components/schemas/BaseCardWithPanAndCvv" }, { "$ref": "#/components/schemas/CreditCardProperties" } ], "title": "Credit card" }, "CardWithPanAndCvv": { "anyOf": [ { "$ref": "#/components/schemas/VirtualCardWithPanAndCvv" }, { "$ref": "#/components/schemas/CreditCardWithPanAndCvv" } ] }, "CardStatusChangeReasonCode": { "properties": { "statusChangeReasonCode": { "description": "The reason a card's status is being updated. Please see table below for allowable statuses based on reason code.\n\n| Peach Card Status Change Reason Code | Allowable Peach Card Status |\n|---------------------------------------|-----------------------------|\n| cardCanceled | canceled |\n| cardExpired | expired |\n| cardInvalid | invalid |\n| cardClosed | terminated |\n| cardDamaged | terminated |\n| cardFraudulent | paused |\n| cardInactive | inactive |\n| cardLost | paused |\n| cardPFraud | paused |\n| cardSuspended | suspended |\n| cardUnauthorized | invalid |\n| cardAcceptorActivityQuestionable | paused |\n| cardStolen | terminated |\n", "enum": [ "cardCanceled", "cardExpired", "cardInvalid", "cardClosed", "cardDamaged", "cardFraudulent", "cardInactive", "cardLost", "cardPFraud", "cardSuspended", "cardUnauthorized", "cardAcceptorActivityQuestionable", "cardStolen" ], "type": "string" } }, "type": "object" }, "PutCardWithPanAndCvv": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/VirtualCardWithPanAndCvv" }, { "$ref": "#/components/schemas/CardStatusChangeReasonCode" } ], "title": "Virtual card" }, { "allOf": [ { "$ref": "#/components/schemas/CreditCardWithPanAndCvv" }, { "$ref": "#/components/schemas/CardStatusChangeReasonCode" } ], "title": "Credit card" } ] }, "LoanChargeOff": { "allOf": [ { "properties": { "chargedOffReason": { "description": "The reason for loan charge off:\n\n`term` means the loan was charged off per loan type configuration after X days overdue.\n\n`fraudulent` means the loan was charged off for fraudulent reason. If the loan is reported to one or more credit bureaus, the system will automatically send a special request to each bureau to delete the tradeline due to confirmed fraud. This is the only reason that the system will automatically trigger a request to delete the tradeline. For other reasons, if you need to delete the tradeline please call the `Delete from credit reporting` endpoint or use an agent tool.\n\n`bankruptcy` means the loan was charged off because of bankruptcy.\n\n`legal` means the loan was charged off because of some legal reason.\n", "enum": [ "term", "fraudulent", "bankruptcy", "legal" ], "type": "string" }, "effectiveDate": { "description": "The effective date of the loan charge-off. The date should be the current date in the product timezone.\nPassing in `\"today\"` will also set the field to today's date.\n", "format": "date", "type": "string" }, "sendNotice": { "default": true, "description": "Only applicable to `chargedOffReason=term`. If `chargedOffReason` is one of the following reasons [fraudulent, bankruptcy, legal], the system will ignore the `sendNotice` value and will NOT send the `loanChargedOffUnsecured` notice.\n\nIf `chargedOffReason=term` and the passed value is `false`, the system will NOT send the `loanChargedOffUnsecured` notice to the borrower.\n", "type": "boolean" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ], "required": [ "effectiveDate", "chargedOffReason" ] }, "LoanChargeOffResponse": { "properties": { "chargeOffAmount": { "description": "The amount charged-off.", "format": "float", "type": "number" } }, "type": "object" }, "CollectionAgencyLoanDetailsBase": { "properties": { "agencyExternalId": { "description": "The lender's external identifier for the agency.", "readOnly": true, "type": "string" }, "assignedOnDate": { "description": "The date when the loan was assigned to a debt collection agency. If a date is not passed, the system will set the date to today.\n", "format": "date", "nullable": true, "type": "string" }, "assignmentType": { "description": "The type of loan assignment to a debt collection agency.\n\n`wholeSale` - The loan was sold to a third party debt collections\nagency. The loan is no longer managed by Peach as the system of\nrecord.\n\n`contingency` - Collection efforts are performed by a third party\ndebt collections agency. The loan is still managed by Peach as the\nsystem of record.\n", "enum": [ "wholeSale", "contingency" ], "nullable": false, "type": "string" }, "metro2": { "properties": { "reportK2Segment": { "default": false, "description": "Only applicable to loans that are reported to credit bureaus.\n\nIf `true`, the system will report the K2 segment in the Metro2\nfile to indicate that the loan has been sold to a third party\ndebt collections agency. The Peach system will report the loan\nfor the final time in the period the loan is assigned to the\ncollections agency. After that, Peach will not report the loan\nagain; it is the new collection agency's responsibility to\nhandle all future reporting.\n\nIf `false`, the system will not report the K2 segment in the\nMetro2 file. Peach will continue to report the loan.\n", "nullable": false, "type": "boolean" } }, "type": "object" }, "status": { "description": "`pendingAssignment` - the loan is in the process of being assigned to an agency. It might take a few days for the agency to be ready to start collecting debt. Peach cannot collect payments.\n\n`assigned` - the loan was successfully assigned to an agency. The borrower should contact the agency for details. Peach cannot collect payments and loan balances might not be accurate.\n", "enum": [ "unassigned", "pendingAssignment", "assigned" ], "type": "string" } }, "type": "object" }, "CollectionAgencyLoanDetailsGet": { "allOf": [ { "properties": { "agencyId": { "description": "The agency's unique identifier.\n", "readOnly": true, "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/CollectionAgencyLoanDetailsBase" } ] }, "CollectionAgencyLoanDetailsPut": { "allOf": [ { "properties": { "agencyId": { "$ref": "#/components/schemas/AnyId", "description": "The agency's unique identifier, internal or lender's external.\n", "writeOnly": true } }, "type": "object" }, { "$ref": "#/components/schemas/CollectionAgencyLoanDetailsBase" } ] }, "CreditLimitProperties": { "allOf": [ { "properties": { "adverseActionReason": { "description": "The reason why the credit limit was changed. If passed, the copy used in the `locCreditLimitChanged` communication\ntemplate. Make sure to phrase the copy as a full sentence or paragraph.\n", "type": "string" }, "creditLimitAmount": { "description": "The credit limit amount for the line or draw. Only applicable to line of credit or installment loan with multiple\nadvances. For installment loans with multi-advances, it is the amount financed set at origination.\n", "format": "float", "type": "number" }, "sendNotice": { "default": true, "description": "Whether the system sent `locCreditLimitChanged` notice to the borrower.\n", "type": "boolean" } }, "required": [ "creditLimitAmount" ], "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ] }, "CreditReportingStatusBase": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "accountStatusCode": { "description": "The metro2 account status code. This is a 2 digit code that indicates the status of the account.\nThis is given by the lender in either in loan cancelation or opting a loan out of credit reporting.\n", "readOnly": true, "type": "string" }, "loanId": { "description": "The unique loan identifier.", "readOnly": true, "type": "string" } }, "type": "object" } ] }, "StartCreditReporting": { "allOf": [ { "$ref": "#/components/schemas/CreditReportingStatusBase" }, { "properties": { "creditAgencyId": { "description": "The unique credit agency identifier.", "type": "string" }, "reportingStartDate": { "description": "When a new loan is created the system automatically starts reporting to all agencies that are configured in the loan type configuration. In that case the `reportingStartDate` will be equal to the loan's `activatedAt` date.\n\nWhen an existing loans (aka loan in flight) needs to be reported, the `reportingStartDate` indicates how much of the loan's history should be reported. If a full history needs to be reported, set the `reportingStartDate` to be equal to loan's `activatedAt` date.\n", "format": "date", "type": "string" } }, "type": "object" } ] }, "DeleteCreditReporting": { "allOf": [ { "$ref": "#/components/schemas/CreditReportingStatusBase" }, { "properties": { "caseId": { "description": "An identifier for an existing case.", "nullable": true, "type": "string", "writeOnly": true }, "deletedReason": { "description": "The reason why the loan was stopped from being reported.\n", "enum": [ "legal", "fcraDispute", "loanDataCorrupted", "fraudulent", "other" ], "type": "string" }, "deletedReasonDetails": { "description": "Additional details about why the loan was stopped from being reported.\n", "type": "string" }, "metro2": { "$ref": "#/components/schemas/LoanCancelMetro2RequestBody" }, "reportingEndDate": { "description": "This attribute has a value (date) if the loan needs to be deleted or was already deleted from being reported to the credit agency.\n\nOnce the loan is deleted, it cannot be reported again.\n", "format": "date", "readOnly": true, "type": "string" } }, "type": "object" } ] }, "CreditReportingStatus": { "allOf": [ { "$ref": "#/components/schemas/StartCreditReporting" }, { "$ref": "#/components/schemas/DeleteCreditReporting" } ], "title": "Credit Reporting Status" }, "LoanCreditReportingFields": { "properties": { "metro2": { "properties": { "complianceConditionCode": { "description": "Compliance condition code that if set will be reported to credit agencies. This value will override any other value currently reported in the Special Comment field in the Base Segment.\nThe system will reset the value to \"empty\" after it is used in the upcoming credit reporting.\n", "maxLength": 2, "type": "string" }, "ecoaCodeBaseSegment": { "description": "ECOA code that if set will be reported to credit agencies. This value will override any other value currently reported in the ECOA Code field in Base Segment.\nThe system will reset the value to \"empty\" after it is used in the upcoming credit reporting.\n", "maxLength": 1, "type": "string" }, "specialCommentBaseSegment": { "description": "Special comment code that if set will be reported to credit agencies. This value will override any other value currently reported in the Special Comment field in the Base Segment.\nThe system will reset the value to \"empty\" after it is used in the upcoming credit reporting.\n", "maxLength": 2, "type": "string" } }, "type": "object" } }, "type": "object" }, "customPaymentPlanAmount": { "description": "Amount required to be fulfilled for each payment plan period. The `amount` provided should be the recurring amount rather than the total amount\nof the plan. Peach's system will use the amount provided to determine whether the borrower is past due and report to bureaus accordingly (if applicable).\nNote: Any fees added during the duration of the payment plan must also be paid in order for the borrower to remain \"current\".\n\n`amount` can be higher or lower than the borrower's originally contracted amount. Peach's system will revert to the recurring amount after the payment\nplan end date if the loan still has a balance at the end of the payment plan.\n\nDo not pass this attribute if the payment plan type is `interestAndFees`.\n", "format": "float", "type": "number" }, "customPaymentPlanCancellationReason": { "description": "The cancellation reason:\n\n`canceledByUser` - payment plan was canceled by an agent or borrower.\n\n`loanTermsChanged` - loan terms changed.\n\n`loanChargedOff` - loan was charged off.\n\n`loanAccelerated` - loan was accelerated.\n\n`otherPaymentPlanOffered` - another payment plan was offered.\n\n`other` - for any other reason requiring cancellation.\n", "enum": [ "canceledByUser", "loanTermsChanged", "loanChargedOff", "loanAccelerated", "otherPaymentPlanOffered", "other" ], "type": "string" }, "customPaymentPlanExternalId": { "description": "A lender's identifier for a payment pay plan.\n\nAfter the object is successfully created, a lender can use ID or externalId identifiers to fetch the object.\n\nTo fetch the object using externalId you need to add `ext-` to the URL.\n\nNote: Don't add ext- to the identifier value. For example: if the external identifier is `ABCDE`, then pass externalId=ACBCE\nand NOT ext-ABCDE when creating the object.\n", "type": "string" }, "customPaymentPlanIsExtendLoanDuration": { "default": true, "description": "If `true`, the system may adjust and increase the loan `duration` beyond the current end date to accommodate the payment plan. If `false`, the\nsystem will not add additional periods beyond the current loan `duration`.\n", "type": "boolean" }, "customPaymentPlanNumberOfPeriods": { "description": "The number of periods during which the payment plan terms are effective. Represented as the number of `paymentFrequency` periods. The system will\nbegin counting the `numberOfPeriods` from the period represented by the `selectedDueDate`.\n\nThe `numberOfPeriods` of the payment plan must take place within the existing loan duration. Moreover, if `isExtendLoanDuration` is `true`,\nthe `numberOfPeriods` must end on or before the last period of the loan. If `isExtendLoanDuration` is `false`, then `numberOfPeriods` for the payment\nplan must end on or before the second to last payment.\n\nFor example, if the payment plan `frequency=weekly` and `numberOfPeriods=6` and the remaining loan duration is 12, the payment plan will be created with a\n6 weeks duration during which the designated payment plan `amount` is in effect. Any subsequent periods after the payment plan has ended will revert\nto the original periodic payment amount.\n", "type": "integer" }, "customPaymentPlanType": { "default": "fixedAmountAndFees", "description": "Determines how the system will calculate payment plan payments during the payment plan's `numberOfPeriods`.\n\n`fixedAmountAndFees` - the payment plan payment amounts will be set as a recurring `amount`. Note that any configured recurring\nfees (e.g. service fees) will also be included in the payment plan amount unless explicitly canceled. `amount` must be passed at\nthe time of payment plan creation when using this option.\n\n`interestAndFees` - the payment plan amounts will be calculated by Peach's system as \"interest only\". Note that any configured\nrecurring fees (e.g. service fees) will also be included in the payment plan amount unless explicitly canceled. Do not pass `amount`\nwhen using this option.\n", "enum": [ "fixedAmountAndFees", "interestAndFees" ], "type": "string" }, "customPaymentPlanReasonDetails": { "description": "The reason for payment plan cancellation. This is typically entered by an agent canceling a payment plan via the front end.\n", "type": "string" }, "customPaymentPlanSelectedDueDate": { "description": "The due date of the period from which to begin the payment plan. If `selectedDueDate` is not provided upon payment plan creation,\nthe system will use the current period due date as the `selectedDueDate`. If `selectedDueDate` is provided, it must be for a due date in the future.\n", "format": "date", "type": "string" }, "CustomPaymentPlanResult": { "allOf": [ { "properties": { "amount": { "$ref": "#/components/schemas/customPaymentPlanAmount" }, "canceledBy": { "description": "Identifier of the `User` who canceled the payment plan.", "type": "string" }, "cancellationCaseId": { "description": "An identifier for an existing case.", "type": "string" }, "cancellationReason": { "$ref": "#/components/schemas/customPaymentPlanCancellationReason" }, "createdBy": { "description": "Identifier of the `User` who created the payment plan.\n", "type": "string" }, "creationCaseId": { "description": "An identifier for an existing case.", "type": "string" }, "externalId": { "$ref": "#/components/schemas/customPaymentPlanExternalId" }, "id": { "readOnly": true, "type": "string" }, "isExtendLoanDuration": { "$ref": "#/components/schemas/customPaymentPlanIsExtendLoanDuration" }, "numberOfPeriods": { "$ref": "#/components/schemas/customPaymentPlanNumberOfPeriods" }, "paymentPlanType": { "$ref": "#/components/schemas/customPaymentPlanType" }, "reasonDetails": { "$ref": "#/components/schemas/customPaymentPlanReasonDetails" }, "schedule": { "items": { "$ref": "#/components/schemas/ExpectedPayment" }, "type": "array" }, "selectedDueDate": { "$ref": "#/components/schemas/customPaymentPlanSelectedDueDate" }, "status": { "description": "The payment plan status. Once a payment plan is created, it is, by definition, `active`. Once all\nperiods in a payment plan period have passed, it will change status to `inactive`. If a payment plan\nis canceled, it will change status to `canceled`.\n", "enum": [ "active", "inactive", "canceled" ], "type": "string" }, "timestamps": { "properties": { "canceledAt": { "format": "date-time", "readOnly": true, "type": "string" }, "createdAt": { "format": "date-time", "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object" } }, "type": "object" } ] }, "SendNoticeCancelAutopay": { "default": true, "description": "When set to `false`, the system will NOT send a `loanPaymentScheduleChanged` notice to the borrower.\n\nNote: Changing the loan terms will automatically cancel an existing Autopay (if enabled). A borrower, an agent or\nAPI caller needs to turn on / enable a new Autopay plan after the loan terms change is completed. If the loan has Autopay enabled:\n - When `sendNotice=false`, the system will NOT send an `autopayCanceledBySystem` notice.\n - When `sendNotice=true`, the system will send an `autopayCanceledBySystem` notice in addition to the applicable loan terms notice.\n", "type": "boolean" }, "LoanCustomPaymentPlan": { "properties": { "amount": { "$ref": "#/components/schemas/customPaymentPlanAmount" }, "caseId": { "description": "An identifier for an existing case.", "type": "string" }, "externalId": { "$ref": "#/components/schemas/customPaymentPlanExternalId" }, "isExtendLoanDuration": { "$ref": "#/components/schemas/customPaymentPlanIsExtendLoanDuration" }, "numberOfPeriods": { "$ref": "#/components/schemas/customPaymentPlanNumberOfPeriods" }, "paymentPlanType": { "$ref": "#/components/schemas/customPaymentPlanType" }, "previewMode": { "default": false, "description": "In `previewMode=true`, the loan doesn't change, and no changes are saved to the database.", "type": "boolean" }, "selectedDueDate": { "$ref": "#/components/schemas/customPaymentPlanSelectedDueDate" }, "sendNotice": { "$ref": "#/components/schemas/SendNoticeCancelAutopay" } }, "required": [ "numberOfPeriods" ], "type": "object" }, "LoanCustomPaymentPlanCancel": { "properties": { "cancellationReason": { "$ref": "#/components/schemas/customPaymentPlanCancellationReason" }, "caseId": { "description": "An identifier for an existing case.", "type": "string" }, "reasonDetails": { "$ref": "#/components/schemas/customPaymentPlanReasonDetails" }, "sendNotice": { "default": false, "description": "When set to `false`, the system will NOT send a `loanPaymentScheduleChanged` notice to the borrower.\n", "type": "boolean" } }, "required": [ "cancellationReason" ], "type": "object" }, "LoanDeferDueDate": { "allOf": [ { "properties": { "addAfterLastDueDate": { "default": false, "description": "`true` to move the new due date to a date after the last due date. The date will be calculated\nbased upon the existing loan cadence. The `newDueDate` field should be left empty if utilizing this option.\n", "type": "boolean" }, "agreementDocumentId": { "description": "The document descriptor ID corresponding to the accepted loan term change agreement.\n", "type": "string" }, "newDueDate": { "description": "The proposed new due date, chosen from an existing due date after the selected date. The\n`addAfterLastDueDate` field should be toggled to false if utilizing this option.\n", "format": "date", "type": "string" }, "previewMode": { "default": false, "description": "If `previewMode=true`, the loan doesn't change and no changes are saved to the database.\n", "type": "boolean" }, "selectedDueDate": { "description": "The selected due date to defer. It can be the due date of the current period or a future due date in the loan schedule.\n", "format": "date", "type": "string" }, "sendNotice": { "$ref": "#/components/schemas/SendNoticeCancelAutopay" }, "waiveFee": { "default": false, "description": "`true` to charge a fee for deferral of a due date. The fee amount is defined as part of the loan type.\n", "type": "boolean" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ], "required": [ "selectedDueDate" ] }, "DueDateDeferralFeeAmount": { "properties": { "dueDateDeferralFeeAmount": { "description": "The due date deferral fee amount", "type": "integer" } }, "type": "object" }, "LoanDeferSchedule": { "allOf": [ { "properties": { "agreementDocumentId": { "description": "The document descriptor ID corresponding to the accepted loan term change agreement.\n", "type": "string" }, "bufferToPushOutSchedule": { "description": "When deferring during the first period, this represents the number of calendar days that will be added to\ntoday's date. The resulting date will be used to push out due dates (today's date + buffer days). Interest\nwill continue to accrue.\n\nWhen deferring after the first period, we defer all due dates that fall between \"today's date\"\nand \"today's date + buffer days\" to the end of the loan one by one. If the current date falls on a due date,\nit will not be deferred as the period has ended.\n", "nullable": true, "type": "integer" }, "previewMode": { "default": false, "description": "If `previewMode=true`, the loan doesn't change and no changes are saved to the database.\n", "type": "boolean" }, "sendNotice": { "$ref": "#/components/schemas/SendNoticeCancelAutopay" }, "waiveFee": { "default": false, "description": "`true` to charge a deferral fee. The fee amount is defined as part of the loan type.\n", "type": "boolean" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ], "required": [ "bufferToPushOutSchedule" ] }, "CreditLimitPercentage": { "description": "The draw's credit limit as a percentage of the loan's credit limit. Lenders can set and update `creditLimitAmount`,\n`creditLimitPercentage`, or both. If both values are set, the system will use the lower value. The format is decimal.\nFor example, 0.01 is a 1%, 0.2 is a 20%.\n", "format": "float", "type": "number" }, "MinPaymentCalculation": { "description": "The logic to calculate the minimum payment amount when a statement is created.\nAll interest accrued in the period and fees are always part of the minimum payment amount.\n\nIf `includeOverLimitAmount` is set to `true`, the minimum payment amount will include the\nover limit amount at the time of statement generation as part of the required minimum payment.\n\nUsing `percentageOfPrincipal`, lenders can also control what percentage of the outstanding principal\nwill be added to the minimum amount.\n\nStatement logic adds up all draws calculated minimum payment amounts and sets the total as the statement\nminimum amount. If the `loanType.statement` object is configured such that `includeOverdueAmountInMinPayment`\nis set to `true`, the statement minimum payment amount will include the loan/line overdue amount as part of\nthe required minimum payment on the statement.\n", "properties": { "includeOverLimitAmount": { "default": false, "description": "The system first calculates the draw minimum amount, which includes accrued interest,\nfees and some percentage of the outstanding principal.\n\nIf `includeOverLimitAmount=true`, the system would add an over limit amount to the minimum amount.\nThe over limit amount is calculated as `max(utilizationAmount - creditLimitAmount, 0)`\nat the time of statement generation.\n", "type": "boolean" }, "minAmount": { "description": "The minimum periodic amount. For example: $15.00. The minimum will be only enforced if the draw doesn't have an amortized amount.\nThe minimum will not be enforced if the principal of the draw is zero.\n\nExample:\n- Outstanding draw principal is $100.00.\n- `percentageOfPrincipal=0.01` (aka 1%).\n- Interest rate is 2% per month.\n- `minAmount=15`.\n- Interest amount per month is: $100.00 * 2% = $2.00.\n- Minimum amount is: $2 + $100.00 * 1% = $3.00.\n\nThe minimum payment will be set to $15.00 and not $3.00. The split between principal and interest will be: `interest=$2.00` and\n`principal=$13.00`.\n", "format": "float", "type": "number" }, "minInterestChargeAmount": { "default": 0, "description": "The minimum amount of interest charged in a period. If the draw has accrued interest in a billing period, but the amount calculated\nis less than the `minInterestChargeAmount`, the system will add additional interest amount to the draw's interest bucket to equal\nthe `minInterestChargeAmount`.\n", "format": "float", "type": "number" }, "percentageOfPrincipal": { "description": "Percentage of draw's outstanding principal and/or membership fee\n(if applicable).\nThe range is 0-1.\nThe format is decimal.\nFor example, 0.01 is a 1%, 0.2 is a 20%.\n\nFor non-amortized draw or amortized draws for which the amortization\nterm expires, the system will use the `percentageOfPrincipal` to\ncalculate the portion of principal and membership fee (if\napplicable) for minimum amount.\n\nFor amortized draws within the amortization term, the system will use\nthe `percentageOfPrincipal` to calculate membership fee only (if\napplicable) for minimum amount.\nThe principal portion is taken from the expected payments (aka\namortized amount).\n", "format": "float", "maximum": 1, "minimum": 0, "type": "number" } }, "type": "object" }, "RateCapsAtOriginationDraw": { "description": "Rate caps that should apply to the draw at origination. \n\n1. When creating a new Draw:\n - If `atOrigination.rateCaps` is not provided or null, copy the Line of Credit's \n rate caps (if they exist).\n - If `atOrigination.rateCaps` is provided, create the specified rate caps and \n ignore the Line of Credit's existing rate caps.\n - If `atOrigination.rateCaps` is an empty list, neither copy nor create any rate caps\n2. After a Draw is created, it manages its own Rate Caps independently. \n Any updates to the Line of Credit's Rate Caps will not affect the Draw, and vice versa.\n", "items": { "$ref": "#/components/schemas/RateCapAtOrigination" }, "nullable": true, "title": "Rate Caps At Origination", "type": "array" }, "DrawAtOrigination": { "description": "This object contains loan details and terms as they were shown to a borrower at origination.\n", "properties": { "aprEffective": { "description": "The effective APR of the loan at origination. Pass both `aprNominal` and `aprEffective` even if they are equal.\n\nThis field is deprecated for Line of Credit and Draw. You can still pass the value, and it will be stored on the object.\nHowever, it will not be used/displayed anywhere. The system will use the interest rate values of Line of Credit and Draws\nand show them as the APR (for example, on the statement.)\n", "format": "float", "nullable": true, "type": "number" }, "aprNominal": { "description": "The nominal APR of the loan at origination. Pass both `aprNominal` and `aprEffective` even if they are equal.\n\nThis field is deprecated for Line of Credit and Draw. You can still pass the value, and it will be stored on the object.\nHowever, it will not be used/displayed anywhere. The system will use the interest rate values of Line of Credit and Draws\nand show them as the APR (for example, on the statement.)\n", "format": "float", "nullable": true, "type": "number" }, "autoAmortization": { "description": "Draws can be automatically amortized based on lender needs. Amortization of the draw allows borrowers to pay it back over a longer period\nof time. If the draw is not amortized, the minimum amount due will be calculated based on the `minPaymentCalculation` logic.\n\nThe system will automatically amortize the draw only ONCE in the first period in which a purchase was ever made. If more purchases\nwere made in the following periods, the system will NOT automatically re-amortize the draw. If you need to re-amortized the `draw` you should\ncall the `Amortize draw` endpoint.\n\nNote:\n- If the loan type is configured to accrue interest as `accrualMethod=compoundWithFees`, there is a known limitation to the draw amortization\ncalculation logic.\n- The draw amortization calculation will be done using the `compound` method and not `compoundWithFees`. To ensure that the system calculates\ninterest accurately, amortized draws should NOT include any fees.\n", "properties": { "amortizationLogic": { "description": "- `amortizeAfterEachPurchase` - indicates whether the system needs to amortize and re-amortize the draw when a new purchase is posted over `duration`\nperiods. If no new purchases were posted, the system will not re-amortize the draw.\n- `aggregatePurchasesInPeriod` - indicates whether new purchases during a period should be \"aggregated\", added to outstanding draw principal and amortized\nover `duration` periods automatically when the period ends. If no purchases were posted in a period, the system will not re-amortize the draw.\n", "enum": [ "amortizeAfterEachPurchase", "aggregatePurchasesInPeriod" ], "type": "string" }, "amortizationMethod": { "default": "equalPayments", "description": "Loan amortization method.\n\n`equalPayments` - the system will amortize the loan or draw making recurring payments equal (except maybe for the last payment).\nMost installment loans are expected to use this method.\n\n`interestPaymentsBalloonPrincipal` - the system will amortize the loan or draw making recurring payments equal to interest only\nand the last payment will include the entire principal. Keep in mind that if you set `interest.periodAccrualDurationType=actual`,\nthe recurring payment amounts will be different every period for monthly and twice monthly frequencies. This is because a month\ncan have 28, 29, 30 or 31 days and interest accrued will vary based on the number of days in the month.\n\nThere are additional limitations to be aware for `interestPaymentsBalloonPrincipal`. For installment loans, Autopay can only be\naligned to due dates. It means that `autoPay.allowedFrequency.isDueDatesAvailable` must be set to `false`. This way the system\nwill only allow Autopay to be aligned to the loan frequency and due dates.\n", "enum": [ "equalPayments", "interestPaymentsBalloonPrincipal", "custom" ], "readOnly": true, "type": "string" }, "duration": { "description": "The duration of the draw as a number of `paymentFrequency` periods of the line of credit. Only applicable if the draw needs to be amortized. Pass one of the values\nonly, `duration` or `periodicPaymentAmount`.\n", "type": "integer" }, "periodicPaymentAmount": { "description": "The recurring payment amount. The system will calculate the needed duration. Pass one of the values only, `duration` or `periodicPaymentAmount`.", "format": "float", "type": "number" } }, "required": [ "amortizationLogic" ], "type": "object" }, "creditLimitAmount": { "description": "The credit limit.", "format": "float", "type": "number" }, "creditLimitPercentage": { "$ref": "#/components/schemas/CreditLimitPercentage" }, "fees": { "description": "The loan fees.", "properties": { "drawFeeAmount": { "description": "The amount of the draw fee. The draw fee will be due on a due date of the period the draw was activated.\nPass only one of the following values, `drawFeeAmount` or `drawFeePercentageOfPrincipal`.\n", "format": "float", "nullable": true, "type": "number" }, "drawFeePercentageOfPrincipal": { "description": "The percentage of the purchases total amount. The system will calculate the draw fee amount based on the total\nof purchases in the period the draw was activated. The draw fee will be due on a due date of the period the draw\nwas activated. Pass only one of the following values, `drawFeeAmount` or `drawFeePercentageOfPrincipal`.\n", "format": "float", "type": "number" }, "dynamicFees": { "$ref": "#/components/schemas/AtOriginationDynamicFees" }, "serviceFeeAmount": { "description": "**DEPRECATED ATTRIBUTE** Use `dynamicFees.feeAmount`.\n\nThe service fee amount that will be charged recurrently. Only required if the service fee `amountLogic` is configured as\n`type=passedAtOrigination`. In all other cases, the system will calculate the fee based on pre-configured logic.\n", "format": "float", "type": "number" }, "serviceFeeCapAmount": { "description": "**DEPRECATED ATTRIBUTE** Use `dynamicFees.feeCapAmount`.\n\nThe maximum amount of the service fee that can be charged over the life of the loan or draw. Only required if the service fee\n`capLogic` is configured as `type=capPassedAtOrigination`. In all other cases, the system will calculate the fee based on pre-configured\nlogic.\n", "format": "float", "type": "number" } }, "type": "object" }, "gracePeriod": { "description": "The logic to handle grace period benefit. The draw level grace period functionality depends on the line/loan `isGracePeriodApplicable` attribute value that was passed in the `Create loan` endpoint.\n\nThe grace period benefit can work in two ways in Peach:\n- Line level - in this case, the loan/line and all draws must meet the grace period repayment requirement.\n If one of the draws didn't meet the repayment requirement (in other words the entire line didn't meet the repayment requirement),\n all draws eligible for the grace period benefit would lose the grace period benefit and accrue interest.\n- Draw level - in this case each applicable/enrolled draw needs to meet its own grace period repayment requirements.\n If one of the applicable/enrolled draws didn't meet the repayment requirements, other draws might still be eligible for the grace\n period benefit (as long as they meet their own requirements).\n\nLine level (`loan.isGracePeriodApplicable=true`):\n- Assuming you enrolled the line/loan in the grace period benefit when you created the loan/line via `Create loan` endpoint, you can\nset the following draw-level attributes:\n- `draw.isGracePeriodApplicable`:\n - `false` - the draw participates in the eligibility evaluation for the entire line/loan. The draw will accrue interest based on\n the draw interest rate even when the line is eligible for the benefit.\n - `true` - the draw participates in the eligibility evaluation for the entire line/loan. The draw will NOT accrue interest in periods\n when the loan/line is eligible for the grace period benefit.\n- `draw.paymentRequirementForGrace` - defines what portion of the draw needs to be repaid every period to keep the line eligible for the benefit.\n - Keep in mind that you can set `draw.isGracePeriodApplicable=false` AND `draw.paymentRequirementForGrace = [minAmount, fullBalance]`.\n It means that the draw will accrue interest (aka not subject to the grace period benefit). But, the line eligibility depends on\n repayment of a portion of the draw. This configuration can be used for amortized draws when the borrower is expected to accrue interest\n but has to pay the amortized recurring amount every period to keep the line eligible for the grace period.\n- `draw.numPeriodsToRestoreGrace` - is superseded by the line/loan level's `numPeriodsToRestoreGrace` value.\n- The following configurations are not allowed:\n - `draw.isGracePeriodApplicable=true` AND `draw.paymentRequirementForGrace=none`\n - `draw.isGracePeriodApplicable=true` for amortized draws. Amortized draws can participate in grace eligibility evaluation for a line/loan,\n but are not designed to be subject to the grace period benefit (in other words, amortized draws are expected to accrue interest if an interest\n rate greater than zero was set on the draw).\n\nLine level (`loan.isGracePeriodApplicable=false`):\n- Assuming you didn't enroll the line/loan in the grace period benefit when you created the loan/line via the `Create loan` endpoint, you can still\nenroll individual draws in the grace period benefit:\n- `draw.isGracePeriodApplicable`:\n - `false` - the draw is not enrolled in the grace period benefit and will accrue interest based on the draw interest rate.\n - `true` - the draw is enrolled in the grace period benefit. The draw will NOT accrue interest in periods when the draw is eligible for the grace period benefit.\n- `draw.paymentRequirementForGrace` - defines what portion of the draw needs to be repaid every period to keep the draw eligible for the benefit.\n- `draw.numPeriodsToRestoreGrace` - defines number of periods to wait after the grace period benefit was revoked, and before it can become eligible again.\n- The following configurations are not allowed:\n - `draw.isGracePeriodApplicable=false` AND `draw.paymentRequirementForGrace in [minAmount, fullBalance]`\n - `draw.isGracePeriodApplicable=true` for amortized draws. Amortized draws are not designed to be subject to the grace period benefit (in other\n words, amortized draws are expected to accrue interest if an interest rate greater than zero was set on the draw).\n\nIf the `gracePeriod` object is not passed, the system will assume that grace period benefit is not applicable to the draw.\n\nImportant: the grace period attributes cannot be changed after the draw is activated.\n", "properties": { "isGracePeriodApplicable": { "description": "Defines how the interest on draw should accrue when the draw is eligible for the grace period benefit.\n\n`false` - the draw will accrue interest regardless of the grace period benefit eligibility.\n\n`true` - the draw will NOT accrue interest in periods when the loan/line and/or draw is eligible for the grace period benefit.\n", "type": "boolean" }, "numPeriodsToRestoreGrace": { "description": "Number of periods to wait after the grace period benefit was revoked before the draw can become eligible again.\nTo take advantage of the grace period, the borrower must pay their account balance according to the grace period benefit requirements on time for the number of billing periods provided.\n\nIf you enrolled the loan/line in the grace period benefit when you created the loan via the `Create loan` endpoint, don't pass this attribute.\nThe system will set the draw-level value equal to the loan/line-level value of `numPeriodsToRestoreGrace`.\n", "type": "integer" }, "paymentRequirementForGrace": { "description": "This attribute determines the portion of a draw that needs to be repaid every period in order for the line/loan and/or draw to be\neligible for the grace period benefit.\n\nImportant:\n - If the grace period benefit was set on the loan/line level, ALL draws participate in the eligibility evaluation regardless of the\ndraw-level `isGracePeriodApplicable` value.\n\n= `minAmount` - requires the minimum amount of the draw to be paid every period.\n - For an amortized draw, the minimum amount is the amortized periodic/recurring amount and applicable fees.\n - For non-amortized draw, the minimum amount is what statement logic calculates.\n= `fullBalance` - requires the full balance of the draw to be paid every period. Don't set `fullBalance` for amortized draws.\n", "enum": [ "minAmount", "fullBalance" ], "type": "string" } }, "type": "object" }, "interestRates": { "$ref": "#/components/schemas/LoanInterestRatesAtOrigination" }, "mdr": { "$ref": "#/components/schemas/MerchantDiscountRateObj" }, "minPaymentCalculation": { "$ref": "#/components/schemas/MinPaymentCalculation" }, "promoRates": { "$ref": "#/components/schemas/LoanPromoRatesAtOrigination", "nullable": true }, "rateCaps": { "$ref": "#/components/schemas/RateCapsAtOriginationDraw" } }, "type": "object" }, "DrawAtOriginationCreate": { "allOf": [ { "$ref": "#/components/schemas/DrawAtOrigination" }, { "properties": { "minPaymentCalculation": { "allOf": [ { "$ref": "#/components/schemas/MinPaymentCalculation" }, { "required": [ "percentageOfPrincipal" ], "type": "object" } ] } }, "type": "object" } ] }, "BaseDraw": { "allOf": [ { "$ref": "#/components/schemas/BaseMixinWithoutTimestamps" }, { "$ref": "#/components/schemas/BaseLoanMixin" }, { "properties": { "atOrigination": { "$ref": "#/components/schemas/DrawAtOriginationCreate", "required": [ "minPaymentCalculation" ] }, "current": { "allOf": [ { "properties": { "creditLimitAmount": { "description": "The credit limit amount.", "format": "float", "type": "number" }, "duration": { "$ref": "#/components/schemas/LoanDuration" }, "minPaymentCalculation": { "$ref": "#/components/schemas/MinPaymentCalculation" }, "paymentFrequency": { "$ref": "#/components/schemas/InstallmentPaymentFrequency" }, "periodicPayment": { "description": "The most recent amortized periodic payment that was calculated on `lastAmortizedAt`.", "format": "float", "type": "number" }, "specificDays": { "$ref": "#/components/schemas/SpecificDays" } }, "type": "object" } ], "description": "This object contains some draw details that were modified after origination.", "readOnly": true }, "isClosed": { "description": "Indicates whether the Draw is closed. If `true`, new Purchases cannot be created.\n", "type": "boolean" }, "nickname": { "default": "Draw", "description": "The draw's nickname as displayed in the UI.", "type": "string" }, "object": { "enum": [ "draw" ], "readOnly": true, "type": "string" }, "ratesValidation": { "allOf": [ { "$ref": "#/components/schemas/InterestRateValidation" } ], "description": "This object contains information on whether actual rates exceed the rate ranges defined on the loan type.", "readOnly": true }, "status": { "$ref": "#/components/schemas/LoanStatus" } }, "required": [ "status" ], "type": "object" } ], "title": "BaseDraw" }, "DrawResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseDraw" }, { "properties": { "drawType": { "description": "Describes the type of line of credit purchases associated with the draw. Typically used in credit card use cases\nin which lenders set up draws specifically to be used for cash advances, balance transfers, etc.\n\n`cashAdvance` - must be set in order for Peach's system to automatically associate ATM withdrawal and other\n cash-specific transactions with a specific draw. See Create card issuer endpoint and `drawMapping` attribute for additional configuration details.\n\n`balanceTransfer` - enables lenders to create a draw that will house balance transfer transactions.\n\n`regularPurchase` - enables lenders to create a draw used for day-to-day purchases. If this attribute is set,\n Peach's system will automatically associate purchases with this draw based on the card issuer `drawMapping` logic.\n\n`static` - a special draw capturing all past data prior to the \"migration cutoff date\" for a migrated Line of Credit. Automatically created by the\nsystem when a Line of Credit is created with `migrationStatus=prepMigration`.\n", "enum": [ "balanceTransfer", "cashAdvance", "regularPurchase", "static" ], "nullable": true, "type": "string" } }, "type": "object" } ], "title": "Draw Response" }, "DrawsPaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/DrawResponse" }, "type": "array" } }, "type": "object" } ] }, "Draw": { "allOf": [ { "$ref": "#/components/schemas/BaseDraw" }, { "properties": { "drawType": { "description": "Describes the type of line of credit purchases associated with the draw. Typically used in credit card use cases\nin which lenders set up draws specifically to be used for cash advances, balance transfers, etc.\n\n`cashAdvance` - must be set in order for Peach's system to automatically associate ATM withdrawal and other\n cash-specific transactions with a specific draw. See Create card issuer endpoint and `drawMapping` attribute for additional configuration details.\n\n`balanceTransfer` - enables lenders to create a draw that will house balance transfer transactions.\n\n`regularPurchase` - enables lenders to create a draw used for day-to-day purchases. If this attribute is set,\n Peach's system will automatically associate purchases with this draw based on the card issuer `drawMapping` logic.\n", "enum": [ "balanceTransfer", "cashAdvance", "regularPurchase" ], "nullable": true, "type": "string" } }, "type": "object" } ], "title": "Draw" }, "DrawAtOriginationUpdate": { "allOf": [ { "$ref": "#/components/schemas/DrawAtOrigination" }, { "properties": { "minPaymentCalculation": { "$ref": "#/components/schemas/MinPaymentCalculation" } }, "type": "object" } ] }, "DrawActivationResponse": { "properties": { "amountsValidation": { "$ref": "#/components/schemas/AmountsValidation" }, "schedule": { "$ref": "#/components/schemas/LoanSchedule" } }, "type": "object" }, "ExpectedPaymentsResult": { "allOf": [ { "$ref": "#/components/schemas/IsLocked" }, { "properties": { "paymentFrequency": { "description": "The expected payments' frequency.", "enum": [ "weekly", "everyTwoWeeks", "twiceMonthly", "monthly" ], "type": "string" }, "schedule": { "items": { "$ref": "#/components/schemas/ExpectedPayment" }, "type": "array" }, "specificDays": { "$ref": "#/components/schemas/SpecificDays" } }, "type": "object" } ] }, "DeferRemainingBalancesRequest": { "properties": { "caseId": { "description": "An identifier of an existing case.\n", "nullable": true, "type": "string" }, "deferralType": { "description": "The type of deferral.\n\n`capitalizeRemainingBalance` - the system will capitalize\nthe remaining balance, overdue or due, of each obligation\ncorresponding to the selected due dates.\nCapitalization means the following:\n\n- Overdue/due principal will become non-due principal.\n- Overdue/due interest will become non-due principal.\n- Overdue/due fees will become non-due principal.\n\nThe net effect on the loan balance right after the deferral\nis zero.\nKeep in mind that because interest and fees are capitalized\n(aka principal increased), the borrower may accrue more\ninterest in the future.\n\nThe system will not check the line of credit and/or draw\nlevel credit limit.\nFor example, If the line or draw balance before the deferral\nwas above the credit limit, the system will still complete\nthe deferral process.\n", "enum": [ "capitalizeRemainingBalance" ], "nullable": false, "type": "string" }, "previewMode": { "default": false, "description": "If `previewMode=true`, the loan doesn't change and no\nchanges are saved to the database. The preview mode allows\nyou to see the total and breakdown of the deferred amounts.\n", "nullable": false, "type": "boolean" }, "selectedDueDates": { "description": "Selected due dates to defer.\nCan only be due dates for which the statement was already\ngenerated.\nPast due dates should always have statements. Upcoming due\ndate can only be selected if the statement was already\ngenerated.\n\nIf you don't pass a value, the system will find all due\ndates / obligations with remaining balance and defer them.\n\nIf you pass a value, make sure you don't create \"holes\".\nHole is defined as leaving one or more due dates with\nremaining balance while trying to defer more recent due\ndates. The exception is we allow deferring only the most \nrecent due obligation.\nFor example:\n\n- A line has three due dates / obligations with remaining\n balance: `Jun 5`, `Jul 5`, `Aug 5`.\n- You cannot pass the following due dates combinations:\n - `Jul 5` - because it makes Jun 5 a \"hole\".\n - `Jul 5, Aug 5` - because it makes Jun 5 a \"hole\".\n - `Aug 5` - because it makes Jun 5 and Jul 5 \"holes\".\n - `Jun 5, Aug 5` - because it makes Jul 5 \"holes\".\n- You can pass the following due dates combinations:\n - `Jun 5`\n - `Jun 5, Jul 5`\n - `Jun 5, Jul 5, Aug 5`\n - `Aug 5` - the most recent due obligation\n", "items": { "format": "date", "nullable": false, "type": "string" }, "nullable": false, "type": "array" } }, "required": [ "deferralType" ], "type": "object" }, "DeferRemainingBalancesResponse": { "properties": { "deferredDrawIds": { "description": "The list of draws that participated in the deferral process.\n", "items": { "nullable": false, "type": "string" }, "type": "array" }, "deferredDueDates": { "description": "The list of due dates that were deferred.\nKeep in mind that this list can be different from the\n`selectedDueDates` list that was provided.\nFor example: if `selectedDueDates` included a due date that\ndidn't have corresponding obligation's remaining balance >\n0, the system will skip the due date and will not include it\nin the `deferredDueDates` list.\nOr, if the `selectedDueDates` was `null`, the system will\nreturn all due dates with corresponding obligation's\nremaining balance > 0 that were deferred.\n", "items": { "format": "date", "nullable": false, "type": "string" }, "nullable": false, "type": "array" }, "totalDeferredAmounts": { "description": "Total amount that was deferred.\nTo clarify, this is the sum of all amounts that were\ndeferred across all due dates with corresponding\nobligation's remaining amount > 0.\n", "properties": { "allFeesAmount": { "description": "Total of all fees portion of the `totalAmount` deferred.\n", "format": "float", "nullable": false, "type": "number" }, "interestAmount": { "description": "The interest portion of the `totalAmount` that was\ndeferred.\n", "format": "float", "nullable": false, "type": "number" }, "principalAmount": { "description": "The principal portion of the `totalAmount` that was\ndeferred.\n", "format": "float", "nullable": false, "type": "number" }, "totalAmount": { "description": "The total deferred amount that was previously overdue or\ndue.\n", "format": "float", "nullable": false, "type": "number" } }, "required": [ "totalAmount", "interestAmount", "principalAmount", "allFeesAmount" ], "type": "object" } }, "type": "object" }, "DrawMigrationBalances": { "description": "The draw level balances passed here should be as of the \"migration cutoff date\" after the most recent statement was generated in your legal system.\n\nWe expect `balances` to include interest FOR the last date of the previous period (aka endDate) but not for the most recent statement date (which is also the first day of the migration period).\nFor example:\n- Migration period:\n - startDate: Aug 1, 2024\n - endDate: Aug 31, 2024\n - statementDate: Sep 1, 2024\n - dueDate: Sep 22, 2024\n- Previous period (also called \"past period\"):\n - startDate: Jul 1, 2024\n - endDate: Jul 31, 2024\n - statementDate: Aug 1, 2024\n - dueDate: Aug 22, 2024\n- Notes:\n - The balances should be as of Aug 1, 2024 after the statement was generated on Aug 1, 2024.\n - End of day principal balance on Jul 31, 2024: $100.00.\n - The line/draw accrues daily simple interest of 18% annually (with 360 method).\n - The balances passed to Peach should include the daily interest that was accrued at the end of the day Jul 31, 2024:\n - $100.00 * (0.18 / 360) = $0.05\n - Peach system will accrue daily interest for the end of the day Aug 1, 2024 day balance and onward.\n", "properties": { "creditLimitAmount": { "description": "The draw credit limit amount as of the \"migration cutoff date\".\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "dueBalances": { "description": "Due balances represent balances that are currently due.", "properties": { "dueDrawFeesAmount": { "description": "The draw fees portion of `dueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "dueInterestAmount": { "description": "The interest portion of the `dueTotalAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "dueLateFeesAmount": { "description": "The late fees portion of `dueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "dueModificationFeesAmount": { "description": "The modification fees portion of `dueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "duePrincipalAmount": { "description": "The principal portion of the `dueTotalAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" } }, "required": [ "duePrincipalAmount", "dueInterestAmount", "dueDrawFeesAmount", "dueLateFeesAmount", "dueModificationFeesAmount" ], "type": "object" }, "nonDueBalances": { "description": "Non-due balances represent balances that are not yet due.", "properties": { "nonDueDrawFeesAmount": { "description": "The draw fees portion of `nonDueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "nonDueInterestAmount": { "description": "The interest portion of the `nonDueTotalAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "nonDueLateFeesAmount": { "description": "The late fees portion of `nonDueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "nonDueModificationFeesAmount": { "description": "The modification fees portion of `nonDueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "nonDuePrincipalAmount": { "description": "The principal portion of the `nonDueTotalAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" } }, "required": [ "nonDuePrincipalAmount", "nonDueInterestAmount", "nonDueDrawFeesAmount", "nonDueLateFeesAmount", "nonDueModificationFeesAmount" ], "type": "object" }, "overdueBalances": { "description": "Overdue balances represent balances that are overdue.", "properties": { "overdueDrawFeesAmount": { "description": "The draw fees portion of `overdueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "overdueInterestAmount": { "description": "The overdue interest portion of the `overdueTotalAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "overdueLateFeesAmount": { "description": "The late fees portion of `overdueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "overdueModificationFeesAmount": { "description": "The modification fees portion of `overdueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "overduePrincipalAmount": { "description": "The overdue principal portion of the `overdueTotalAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" } }, "required": [ "overduePrincipalAmount", "overdueInterestAmount", "overdueDrawFeesAmount", "overdueLateFeesAmount", "overdueModificationFeesAmount" ], "type": "object" } }, "required": [ "nonDueBalances", "dueBalances", "overdueBalances" ], "type": "object" }, "BaseMigrationGracePeriod": { "properties": { "fullBalanceAmount": { "description": "The full balance amount of the line that is eligible for grace period.", "format": "float", "minimum": 0, "multipleOf": 0.01, "nullable": true, "type": "number" }, "fullBalanceMinusOverdueAmount": { "description": "The full balance amount minus the overdue amount.", "format": "float", "minimum": 0, "multipleOf": 0.01, "nullable": true, "type": "number" }, "isGracePeriodEligible": { "default": true, "description": "Was the loan eligible for grace in this period?", "nullable": false, "type": "boolean" } }, "required": [ "fullBalanceAmount", "fullBalanceMinusOverdueAmount" ], "type": "object" }, "DrawMigrationGracePeriod": { "allOf": [ { "$ref": "#/components/schemas/BaseMigrationGracePeriod" }, { "description": "If you are not migrating past periods and the migration period is the first period of the LOC:\n\nDon't pass the `gracePeriod` object.\n\nIf you are migrating past periods:\n\nThis is the draw level grace period details.\n\nThe draw level grace period data passed here corresponds to the previous period and not to the migration period. By the time you call this endpoint, you should have already created one or more past periods. The additional data that you pass here is only required for the previous period and not for all past periods. That's why the draw level grace period data is part of the \"Create migration period draw data\" vs \"Create past periods data\" endpoint.\n\nThe migration period is a \"live\" period in which you execute migration.\n - Because the Peach system needs to know if the LOC is eligible for the grace period benefit when the migration period starts, the system\n will use the `isGracePeriodEligible` passed here. If you pass `isGracePeriodEligible=true`, the system will start migration without\n accruing interest in the \"migration period\". If you pass `isGracePeriodEligible=false`, the system will start migration with accruing\n interest in the \"migration period\".\n - On the \"due date + 1\" within the \"migration period\", the system evaluates the grace eligibility based on `fullBalanceAmount`, `fullBalanceMinusOverdueAmount` and payments made.\n - If you migrate the LOC/draw before the upcoming \"due date\", the system will evaluate the grace period eligibility in \"live\" and might revoke the benefit.\n - If you migrate the LOC/draw after the \"due date\", the system will evaluate the grace period eligibility as part of the \"replay/migration\" process.\n Because of existing limitations with \"replay\", grace period eligibility cannot be revoked as part of the replay process. However, the replay\n process can reinstate the grace period benefit (in other words, waive accrued interest from the start of the \"migration period\").\n - Peach is responsible for generating the statement corresponding to the migration period on `migrationPeriod.statementDate` in the future.\n The grace period details of the migration period will be calculated by the Peach system on `migrationPeriod.statementDate` in the future.\n\nFor example:\n- Migration period:\n - startDate: Aug 1, 2024\n - endDate: Aug 31, 2024\n - statementDate: Sep 1, 2024\n - dueDate: Sep 22, 2024\n- Previous period (also called \"past period\"):\n - startDate: Jul 1, 2024\n - endDate: Jul 31, 2024\n - statementDate: Aug 1, 2024\n - dueDate: Aug 22, 2024\n- Notes:\n - The draw level grace period details that you need to pass correspond to the previous period that started on Jul 1, 2024 and ended on Jul 31, 2024.\n - The amounts and values should be as of the \"migration cutoff date\", Aug 1, 2024, after the statement was finalized in your legacy system.\n", "type": "object" } ] }, "MigratedDaysOverdue": { "description": "This represents the number of days overdue prior to the \"migration cutoff\" date as it appears in\nthe other system (not Peach). This value is normally calculated as the number of calendar\ndays overdue starting from the earliest overdue obligation's due date to the\n\"migration cutoff date\". This value, once set, won't change after the migration.\n\nThis value will be prorated and added to `daysOverdue` of future obligations\n(if any become overdue). The system will prorate the `migratedDaysOverdue`\ndynamically as the borrower makes payments and add it to the days overdue\npost \"migration cutoff date\".\n\nCalculation details:\n - The `migratedDaysOverdue` value will be used to prorate days overdue prior to the \"migration cutoff date\"\n based on the paid balance of `migratedOverdueAmount` (which is set based on the `balances.overdueBalances`).\n - round_down [migratedDaysOverdue x (1 - min(fulfilledAmount / migratedOverdueAmount, 1))]\n - For example:\n - migratedDaysOverdue = 60\n - migratedOverdueAmount = $1000\n - Scenario 1:\n - Borrower didn't make any payment within the first 30 days after the \"migration cutoff date\".\n - Total days overdue:\n - 60 x (1 - min(0 / 1000, 1)) + 30 = 90\n - Scenario 2:\n - Borrower made payments in a total amount of $700 within the first 30 days after the \"migration cutoff date\". The line is still overdue.\n - Total days overdue:\n - 60 x (1 - min(700 / 1000, 1)) + 30 = 48\n", "minimum": 0, "nullable": false, "type": "integer" }, "DrawMigrationObligation": { "description": "If you are not migrating past periods and the migration period is the first period of the LOC:\n\nDon't pass the `obligation` object.\n\nIf you are migrating past periods:\n\nThis is the draw level obligation details.\n\nThe draw level data passed here corresponds to the previous period and not to the migration period. By the time you call this endpoint, you should have already created one or more past periods. The additional data that you pass here is only required for the previous period and not for all past periods. That's why the draw level obligation data is part of the \"Create migration period draw data\" vs \"Create past periods\" endpoint.\n\nTo remind, the migration period is a \"live\" period in which you execute migration. The draw level obligation details of the migration period will be calculated by the Peach system. Peach is also responsible for generating the statement corresponding to the migration period on `migrationPeriod.statementDate` in the future.\n\nFor example:\n- Migration period:\n - startDate: Aug 1, 2024\n - endDate: Aug 31, 2024\n - statementDate: Sep 1, 2024\n - dueDate: Sep 22, 2024\n- Previous period (also called \"past period\"):\n - startDate: Jul 1, 2024\n - endDate: Jul 31, 2024\n - statementDate: Aug 1, 2024\n - dueDate: Aug 22, 2024\n- Notes:\n - The draw level obligation details that you need to pass correspond to the previous period that started on Jul 1, 2024 and ended on Jul 31, 2024.\n - The amounts and other values should be as of the \"migration cutoff date\", Aug 1, 2024, after the statement was finalized in your legacy system.\n", "properties": { "migratedDaysOverdue": { "$ref": "#/components/schemas/MigratedDaysOverdue" }, "obligationAmount": { "description": "The remaining amount of the previous period's obligation that a borrower needs to pay on the due date that comes after \"migration cutoff date\". The remaining amount should be as of \"migration cutoff date\" vs. \"migration at date\".\n\nThis is the draw level remaining obligation amount.\n\nIf your LOC (or credit card) product doesn't count payments that were made before the statement date towards the statement minimum amount, then `obligationAmount` must be always equal to the draw portion of the whole statement minimum amount.\n\nExample:\n - Migration period:\n - startDate: Aug 1, 2024\n - endDate: Aug 31, 2024\n - statementDate: Sep 1, 2024\n - dueDate: Sep 22, 2024\n - Previous period (also called \"past period\"):\n - startDate: Jul 1, 2024\n - endDate: Jul 31, 2024\n - statementDate: Aug 1, 2024\n - dueDate: Aug 22, 2024\n\nScenario 1:\n - The draw minimum payment was calculated as $100 on the statement date on Aug 1, 2024.\n - A borrower made some payments in the previous period, and based on your waterfall configuration in the legacy system, $30 was counted towards the $100 minimum amount. \n - The remaining minimum amount of $70 is due on Aug 22, 2024.\n - You should pass `obligationAmount=70`.\n\nScenario 2:\n - The draw minimum payment was calculated as $100 on the statement date on Aug 1, 2024.\n - A borrower made some payments in the previous period, and based on your waterfall configuration in the legacy system, none of the payments were counted toward the $100 minimum amount. \n - The minimum amount of $100 is due on Aug 22, 2024.\n - You should pass `obligationAmount=100`.\n\nScenario 3:\n - The draw minimum payment was calculated as $100 on the statement date on Aug 1, 2024.\n - A borrower made early payments in the previous period, and based on your waterfall configuration in the legacy system, the payments were counted toward the $100 minimum amount. \n - The remaining minimum amount of $0 is due on Aug 22, 2024 (in other words, the borrower doesn't need to pay anything on Aug 22, 2024.)\n - You should pass `obligationAmount=0`.\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "nullable": false, "type": "number" } }, "required": [ "obligationAmount", "migratedDaysOverdue" ], "type": "object" }, "MigrationPeriodDrawData": { "properties": { "balances": { "$ref": "#/components/schemas/DrawMigrationBalances" }, "gracePeriod": { "$ref": "#/components/schemas/DrawMigrationGracePeriod" }, "obligation": { "$ref": "#/components/schemas/DrawMigrationObligation" } }, "type": "object" }, "MigrationPeriodDrawDataResponse": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MigrationPeriodDrawData" }, { "properties": { "migratedOverdueAmount": { "format": "float", "nullable": true, "type": "number" } }, "type": "object" } ] } }, "type": "object" } ] }, "MigrationPeriodDrawDataWithRequired": { "allOf": [ { "$ref": "#/components/schemas/MigrationPeriodDrawData" }, { "required": [ "obligation", "gracePeriod", "balances" ], "type": "object" } ] }, "ObligationAmountFields": { "properties": { "capitalizedAmount": { "description": "The total amount capitalized at the end of the period.\n", "format": "float", "nullable": true, "type": "number" }, "fulfilledAmount": { "description": "The total amount of payments and service credits applied to the period.\n", "format": "float", "nullable": true, "type": "number" }, "obligationAmount": { "description": "The amount obligated to be paid by the borrower for the period.\n", "format": "float", "type": "number" }, "overLimitAmount": { "format": "float", "nullable": true, "type": "number" }, "overpaymentsAmount": { "description": "In the case that loan policy allows, this represents the amount of overpayments applied to the period.\nOverpayments will only arise when an obligation is completely fulfilled.\n", "format": "float", "nullable": true, "type": "number" }, "paymentsAmount": { "description": "The total amount of payments applied to the period.\n", "format": "float", "nullable": true, "type": "number" }, "remainingAmount": { "description": "The total amount remaining to be paid by the borrower after accounting for payments\nand service credits applied in the period.\n", "format": "float", "nullable": true, "type": "number" }, "serviceCreditsAmount": { "description": "The total amount of service credits applied to the period.\n", "format": "float", "nullable": true, "type": "number" }, "unassignedAmount": { "description": "This is a special amount that only applies to loan types with `obligationFulfilledCalculation=postStatement` or `obligationFulfilledCalculation=postDueDate` configuration.\nThis is not counted towards an obligation's fulfilled amount.\n\n- For the first obligation, it stores any payment amount that was made before the first statement date (postStatement) or due date (postDueDate) and is not allocated to any obligation.\n- For subsequent obligations, it stores any payment amount that was made between the previous period's due date +1 (inclusive) and current period's end date (inclusive).\n", "format": "float", "nullable": true, "type": "number" } }, "type": "object" }, "ObligationOtherFields": { "properties": { "dueDate": { "description": "The due date of the obligation/period in the product timezone.", "format": "date", "type": "string" }, "isFulfilled": { "description": "`true` if the borrower has completely fulfilled the obligation amount for the period.\n", "type": "boolean" }, "isLateFeeBlockedByPyramidingConfig": { "default": false, "description": "Pyramiding of late fees is a situation where a borrower (who has been previously charged a late fee) pays the current amount due\non a loan without the prior month's late fee included, and the payment is applied to the late fee first, leaving an overdue balance\non the current month's payment, resulting in another late fee.\n\n- If the late fee was configured to allow pyramiding effect, this attribute is not used and will be `false` always.\n- If the late fee was configured to prevent pyramiding effect (`pyramidingLateFeesAllowed=false`), this attribute:\n - `true` - means a late fee was blocked (aka not charged in the period) because of the late fee pyramiding configuration.\n But otherwise would have been charged.\n - `false` - means a late fee was charged because the loan was overdue, or a late fee was not supposed to be charged because\n the loan was current. To clarify, `false` doesn't necessarily mean that a late fee was charged in the period. To understand\n whether a late fee was charged in the period, you should check the dynamic fees endpoint or applicable database table(s).\n", "type": "boolean" }, "isOpen": { "description": "`true` means that the obligation is still \"open\" and the `obligationAmount` is not final. The obligation amount\ncan potentially change until the period ends. `false` means that the obligation is \"sealed\" and the `obligationAmount`\nis final.\n", "type": "boolean" }, "isOverdue": { "description": "`true` if the borrower is currently overdue on the obligation amount for the period.\n", "type": "boolean" }, "migration": { "description": "Used in Line of Credit migration.\n", "properties": { "migratedDaysOverdue": { "description": "The number of calendar days overdue as of the \"migration cutoff date\". This value is pro-rated based on the percentage\nof the `migratedOverdueAmount` paid by the borrower.\n", "nullable": true, "type": "integer" }, "migratedOverdueAmount": { "description": "The overdue balance as of the \"migration cutoff date\". This value is equal to the total of `balances.overdueBalances`\nthat is used to initiate the ledger as of the \"migration cutoff date\". This value won't change after the migration.\n", "format": "float", "nullable": true, "type": "number" }, "migratedOverdueRemainingAmount": { "description": "The overdue balance remaining to be paid as of the \"migration cutoff date\". This value starts out equal to the total of\n`balances.overdueBalances` and decreases as subsequent payments are made by the borrower.\n", "format": "float", "nullable": true, "type": "number" } }, "readOnly": true, "type": "object" }, "periodId": { "description": "The period identifier.", "type": "string" } }, "type": "object" }, "ObligationGracePeriod": { "description": "Data used for grace period logic.", "properties": { "fullBalanceAmount": { "description": "This attribute is only used for grace period benefit logic. The fullBalanceAmount is dependent on the repaymentCriteriaForGrace attribute.\n\nFor repaymentCriteriaForGrace = none, this value is zero.\n\nFor repaymentCriteriaForGrace = minAmount, this amount is the obligation for this period and the unpaid portion of past obligations as of the date when the obligation is \"sealed\".\nLine of credit (and Draw) obligations are \"sealed\" on the statement date.\n\nFor repaymentCriteriaForGrace = fullBalance, this amount is the full statement balance amount (also called \"new balance\") as of the date when the obligation is \"sealed\".\nLine of credit (and Draw) obligations are \"sealed\" on the statement date.\n", "format": "float", "nullable": true, "type": "number" }, "fullBalanceMinusOverdueAmount": { "description": "This attribute is only used for grace period benefit logic. The fullBalanceMinusOverdueAmount is dependent on the repaymentCriteriaForGrace attribute.\n\nFor repaymentCriteriaForGrace = none, this value is zero.\n\nFor repaymentCriteriaForGrace = minAmount, this amount is the obligation for this period as of the date when the obligation is \"sealed\".\nLine of credit (and Draw) obligations are \"sealed\" on the statement date.\n\nFor repaymentCriteriaForGrace = fullBalance, this amount is the full statement balance amount (also called \"new balance\")\nminus any overdue amount as of the date when the obligation is \"sealed\" (aka when isOpen is set to false).\n", "format": "float", "nullable": true, "type": "number" }, "isGracePeriodEligible": { "description": "The grace period status of the obligation period.\n`true` - means that the period is/was eligible for the grace period benefit and interest didn't accrue in the period.\n`false` - means that the period was not eligible for the grace period benefit and interest accrued in the period.", "type": "boolean" }, "totalFulfilledOnDueDateAmount": { "description": "This value is only used for grace period benefit logic. The value will be set one calendar day after the due date.\nThe amount of the obligation for the period fulfilled by service credits and borrower payments as of the end of the\ndue date. This is a sum of `fulfilledAmount` and `overpaymentsAmount`.\n", "format": "float", "nullable": true, "type": "number" } }, "type": "object" }, "ObligationResult": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "$ref": "#/components/schemas/ObligationAmountFields" }, { "$ref": "#/components/schemas/ObligationOtherFields" }, { "properties": { "gracePeriod": { "$ref": "#/components/schemas/ObligationGracePeriod" } }, "type": "object" } ] }, "ObligationsResult": { "allOf": [ { "$ref": "#/components/schemas/IsLocked" }, { "properties": { "daysOverdue": { "description": "Number of calendar days overdue starting from the due date of the earliest overdue obligation to\nthe current date.\n", "type": "integer" }, "isOverdue": { "description": "`true` if the borrower has any obligation overdue on the loan.\n", "type": "boolean" }, "obligations": { "items": { "$ref": "#/components/schemas/ObligationResult" }, "type": "array" }, "overdueAmount": { "description": "The total overdue amount across all obligations on the loan.\n", "format": "float", "type": "number" } }, "type": "object" } ] }, "PromoProgramPost": { "allOf": [ { "$ref": "#/components/schemas/PromoProgramCreate" }, { "properties": { "caseId": { "description": "An identifier for an existing case.", "type": "string" } }, "type": "object" } ], "description": "Create a promo program" }, "PromoCancelReason": { "description": "The cancellation reason.\n\n `adminError` - the promo program was added by mistake.\n\n `expired` - the promo expired.\n\n `disqualified` - the promo was disqualified for various\n reasons.\n\n `borrowerOptedOut` - the borrower decided to opt out from the\n promotional program.\n", "enum": [ "adminError", "expired", "disqualified", "borrowerOptedOut" ], "type": "string" }, "PromoProgramResult": { "properties": { "caseId": { "description": "An identifier for an existing case.", "type": "string" }, "description": { "description": "A legal description of the promotional program as it should\nbe communicated and shown to borrowers.\nIf the description is provided, borrowers will see the\ndescription in the Borrower Portal.\n", "nullable": true, "readOnly": true, "type": "string" }, "displayName": { "description": "The promotional program name as it is shown to borrowers.", "readOnly": true, "type": "string" }, "disqualifyOverdueDays": { "description": "The number of loan overdue days that would disqualify the\npromotional program.\nAny occurrence of `disqualifyOverdueDays` or more of number\ndays overdue during the promotional period would disqualify\n(aka cancel) the promotional program.\n", "type": "integer" }, "externalId": { "description": "A lender's unique identifier for a specific promotional\nprogram.\n", "type": "string" }, "id": { "description": "The promotional program's unique identifier.", "readOnly": true, "type": "string" }, "loanId": { "allOf": [ { "$ref": "#/components/schemas/AnyId" }, { "description": "The ID of the loan the promo program applies to." } ] }, "metaData": { "description": "Store any type of key/value pairs in the form of a JSON\ndictionary.\n", "nullable": true, "type": "object" }, "promoCancelReason": { "$ref": "#/components/schemas/PromoCancelReason" }, "promoCanceledBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for canceling the promotion\nprogram.\nCan be an borrower, agent, or automated system process.\n" }, "promoDurationDays": { "description": "The promotional program duration as a number of calendar\ndays.\nIf `promoDurationDays` is passed, the system will calculate\nthe `promoEndDate`.\nPass only one of the attributes, `promoEndDate` or\n`promoDurationDays`.\n", "type": "integer" }, "promoEffectiveEndDate": { "description": "The promotional program effective end-date inclusive of the\n`promoGracePeriodDays`.\nIf the `promoGracePeriodDays` is not passed, the\n`promoEffectiveEndDate` will be equal to the `promoEndDate`.\n", "format": "date", "readOnly": true, "type": "string" }, "promoEndDate": { "$ref": "#/components/schemas/PromoEndDate" }, "promoGracePeriodDays": { "$ref": "#/components/schemas/PromoGracePeriodDays" }, "promoStartDate": { "$ref": "#/components/schemas/PromoStartDate" }, "promoType": { "$ref": "#/components/schemas/PromoType" }, "promoTypeId": { "description": "The promotional program type's unique identifier.", "type": "string" }, "remainingAmountToExercise": { "description": "The remaining amount needed to satisfy the Same-As-Cash\npromotion.\nOnly returned if `promoStatus=active`.\n", "format": "float", "nullable": true, "type": "number" }, "sacExcercisedRateId": { "description": "The unique rate ID that was created to set on the loan in\norder to exercise the promotion rate.\n", "type": "string" }, "status": { "description": "The promotional program status on a specific loan.\n\n `pending` - the promotion was created but was not\n activated yet.\n\n `active` - the promotion is active.\n\n `canceled` - the promotion has been canceled for a reason.\n The reason provided in the `promoCancelReason` attribute.\n\n `exercised` - the promotion was successfully exercised.\n", "enum": [ "pending", "active", "canceled", "exercised" ], "readOnly": true, "type": "string" }, "timestamps": { "description": "Timestamps of the transaction statuses.", "properties": { "activatedAt": { "format": "date-time", "type": "string" }, "canceledAt": { "format": "date-time", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "exercisedAt": { "format": "date-time", "type": "string" }, "reactivatedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "totalDeferredInterestAmount": { "description": "The total deferred interest amount at the time when promo\nstatus changed from `active` to `canceled` or `exercised`.\n\nWhen the promotion is `canceled` the total deferred interest\nis added to the loan interest and the borrower is expected\nto pay it.\nWhen the promotion is `exercised` the total deferred\ninterest is foregone and the borrower is not expected to pay\nit.\n\nIf the promo status is `active` the value will be empty.\nIf you want to know how much deferred interest was accrued\non an `active` promotion, please use \"Get loan balances\" or\n\"Get draw balances\" endpoints.\n", "format": "float", "type": "number" } }, "type": "object" }, "PromoProgramPutCommon": { "properties": { "caseId": { "description": "An identifier for an existing case.", "type": "string" }, "disqualifyOverdueDays": { "description": "The number of loan overdue days that would disqualify\nthe promotional program.\nAny occurrence of `disqualifyOverdueDays` or more during\nthe promotional period would disqualify (aka cancel) the\npromotional program.\n", "type": "integer" }, "externalId": { "description": "A lender's unique identifier for a specific promotional\nprogram.\n", "type": "string" }, "metaData": { "description": "Store any type of key/value pairs in the form of a JSON\ndictionary.\n", "nullable": true, "type": "object" }, "promoDurationDays": { "description": "The promotional program duration as a number of calendar\ndays.\nIf `promoDurationDays` is passed, the system will\ncalculate the `promoEndDate`.\nPass only one of the attributes, `promoEndDate` or\n`promoDurationDays`.\n", "type": "integer" }, "promoEndDate": { "$ref": "#/components/schemas/PromoEndDate" }, "promoGracePeriodDays": { "$ref": "#/components/schemas/PromoGracePeriodDays" }, "promoStartDate": { "$ref": "#/components/schemas/PromoStartDate" } }, "type": "object" }, "PromoProgramDeleteResult": { "allOf": [ { "$ref": "#/components/schemas/PromoProgramResult" }, { "properties": { "sendNotice": { "default": true, "description": "When set to `true` the system will send a\n`promoProgramCanceled` notice to the borrower.\n", "type": "boolean" } }, "type": "object" } ] }, "PurchaseExtraInput": { "properties": { "authorizedAt": { "description": "The timestamp when the purchase was `authorized`. This value can be set by lenders at the time of purchase creation.\nIf the value is not set by the lender, it will be populated based on `authorizedAt` (if it is non-null) otherwise `createdAt` for the corresponding `authorizationPurchaseId`.\nIf the value is not set by the lender and no `authorizationPurchaseId` is set, this value corresponds to `purchase.authorized` event.\nIf the purchase was never in `authorized` status and none of the prior conditions are met, this value will be null.\n", "format": "date-time", "type": "string" }, "effectiveAt": { "description": "The effective timestamp when the purchase was applied in the ledger. This attribute can be passed only during the line of credit migration process.\nDon't use this attribute after the migration process was successfully completed.\n\n`effectiveAt` is equal to the timestamp when the purchase is set to `pending` or `settled` status, whichever comes first.\nThe timezone is UTC for this timestamp and the format is ISO. For example, in order to set a purchase `effectiveAt` to July 28th 2022,\n10:44 am PDT, send `2022-07-28T17:44:00Z`.\n", "format": "date-time", "type": "string" } }, "type": "object" }, "PurchaseUpdate": { "properties": { "amount": { "description": "The amount of the purchase.", "minimum": 0, "type": "number" }, "authorizationPurchaseId": { "description": "Peach's unique or lender's external identifier for the authorization purchase. This attribute is used to reference an initial authorization, so\nlenders know which captures (purchase object(s) in Peach) are related to the original authorization.\n", "type": "string" }, "authorizedAt": { "description": "The timestamp when the purchase was `authorized`.\n", "format": "date-time", "type": "string" }, "declineReason": { "$ref": "#/components/schemas/PurchaseDeclineReason", "description": "The reason the purchase was declined" }, "effectiveAt": { "description": "The effective timestamp when the purchase was applied in the ledger. `effectiveAt` is equal to the timestamp when the purchase is set to\n`pending` or `settled` status, whichever comes first. Changing the `effectiveAt` via the `Update purchase` endpoint will trigger a replay\nof the line of credit. Keep in mind that an existing statement might've included the purchase based on the existing `effectiveAt` value\nand the interest was accrued based on the existing `effectiveAt`. `effectiveAt` can be updated only if the purchase is in `settled` or `pending` status.\n\nThe timezone is UTC for this timestamp and the format is ISO.\nFor example, in order to set a purchase `effectiveAt` to July 28th 2022, 10:44 am PDT, send `2022-07-28T17:44:00Z`\n", "example": "2022-06-10T11:45Z", "format": "date-time", "type": "string" }, "externalId": { "description": "The lender's identifier for the purchase.", "nullable": true, "type": "string" }, "metadata": { "type": "object" }, "originalPurchaseId": { "description": "Peach's unique or lender's external identifier. Typically used for purchases of type `refund` which allows the lender to\nreference the original purchase being refunded. For authorizations, please see `authorizationPurchaseId` attribute.\n", "type": "string" }, "purchaseDate": { "description": "The date of a purchase. This attribute can be passed only during the line of credit migration process.\nDon't use this attribute after the migration process was successfully completed.\n\n- The value must be before or equal to today, and cannot be greater than the \"migration at date\" (aka the actual date on which you run the migration.)\n- If you pass `purchaseDate` you cannot pass `authorizedAt` and/or `effectiveAt`.\n- If `purchaseDate` is passed, the system will set `authorizedAt` and `effectiveAt` to `purchaseDate` at 6:00 AM in the product timezone.\n- If you `purchaseDate` is not passed, you must pass both `authorizedAt` and `effectiveAt`. `authorizedAt` cannot be greater than `effectiveAt`.\n\nFor non-migrated purchases:\n- The value is equal to the date part of the `authorizedAt` converted to the product timezone (e.g. Eastern or Pacific).\n If `authorizedAt` is null, this value is equal to the date part of the purchase's `createdAt` converted to the product timezone.\n\nThe `purchaseDate` is returned in Get endpoints for both migrated and non-migrated purchases.\n", "format": "date", "type": "string" }, "purchaseDetails": { "$ref": "#/components/schemas/PurchaseDetails" }, "status": { "$ref": "#/components/schemas/PurchaseStatus" } }, "type": "object" }, "PurchaseUpdateInternal": { "allOf": [ { "$ref": "#/components/schemas/PurchaseUpdate" }, { "properties": { "refundDetails": { "$ref": "#/components/schemas/InternalRefundDetails" } }, "type": "object" } ] }, "RateCapEndDate": { "description": "Rate cap end date in product timezone, inclusive. If null, applies until end of loan/draw.\n", "format": "date", "nullable": true, "type": "string" }, "RateCapStartDate": { "description": "Rate cap start date in product timezone, inclusive.", "format": "date", "type": "string" }, "RateCap": { "description": "The Rate Cap object represents the rate caps associated with each loan or draw. \nRate caps apply to both `spread` and `absolute` rate types. If two or more rate \ncaps overlap on the same dates, we will use the lowest value.\n", "properties": { "createdAt": { "description": "When the rate cap was created.", "format": "date-time", "type": "string" }, "endDate": { "$ref": "#/components/schemas/RateCapEndDate" }, "id": { "description": "The rate cap identifier.", "type": "string" }, "maxRate": { "$ref": "#/components/schemas/RateCapMaxRate" }, "rateCapReason": { "$ref": "#/components/schemas/RateCapReason" }, "startDate": { "$ref": "#/components/schemas/RateCapStartDate" }, "updatedAt": { "description": "When the rate cap was last updated.", "format": "date-time", "type": "string" } }, "title": "Rate Cap", "type": "object" }, "RateCapAdd": { "description": "Request body for adding a new rate cap.", "properties": { "endDate": { "$ref": "#/components/schemas/RateCapEndDate" }, "maxRate": { "$ref": "#/components/schemas/RateCapMaxRate" }, "rateCapReason": { "$ref": "#/components/schemas/RateCapReason" }, "startDate": { "$ref": "#/components/schemas/RateCapStartDate" } }, "required": [ "maxRate", "startDate", "rateCapReason" ], "title": "Rate Cap Add", "type": "object" }, "RateCapId": { "description": "The rate cap identifier.", "example": "RC-ABCD-1234", "pattern": "^RC-[A-Z0-9]{4}-[A-Z0-9]{4}$", "type": "string" }, "RateCapUpdate": { "description": "Request body for updating an existing rate cap.", "properties": { "endDate": { "$ref": "#/components/schemas/RateCapEndDate" }, "maxRate": { "$ref": "#/components/schemas/RateCapMaxRate" }, "rateCapReason": { "$ref": "#/components/schemas/RateCapReason" }, "startDate": { "$ref": "#/components/schemas/RateCapStartDate" } }, "title": "Rate Cap Update", "type": "object" }, "LoanRate": { "description": "Loan can have multiple rates. If two or more `interestRate` overlap on the same date we use the lowest value.\nIf two or more `promoRate` overlap on the same date, we take the sum of the promo rates for the given day, and cap this rate at the maximum interest rate for the given day (to avoid accruing negative interest).", "properties": { "annualRate": { "description": "The annual interest or promo rate for the period defined. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate.", "format": "float", "type": "number" }, "endDate": { "description": "The rate end date in the product timezone. The end date is inclusive.\nIf `null` then the rate is applicable until the end of the loan.\n", "format": "date", "nullable": true, "type": "string" }, "id": { "description": "Unique identifier of the interest or promo rate.", "readOnly": true, "type": "string" }, "setAtActivation": { "description": "`true` if the rate was set at loan activation. Rates set at activation cannot be removed\nwithout a special permission. Rates set after activation are set as `false` and do not\nrequire a special permission for removal.\n", "readOnly": true, "type": "boolean" }, "startDate": { "description": "The rate start date in the product timezone. The start date is inclusive.", "format": "date", "type": "string" }, "status": { "description": "The status of the rate.\n`active` - the rate is active.\n`inactive` - the rate is inactive as it was removed.\n", "enum": [ "active", "inactive" ], "type": "string" }, "type": { "enum": [ "interestRate", "promoRate" ], "readOnly": true, "type": "string" } }, "required": [ "annualRate", "startDate" ], "type": "object" }, "InterestRate": { "allOf": [ { "$ref": "#/components/schemas/LoanRate" } ], "description": "An interest rate on a loan.\n\nThe system will treat the provided value according on the interest type that was set at the time of origination (see `atOrigination.interestType` attribute.)\n\nTo remind, `interestType` can have one of the following values: `absolute` or `spread`.\n\n`absolute` - interest rates defined as `absolute` will use the value as provided in the `annualRate` attribute without adding the Index Interest Rate.\n - Negative interest `annualRate` value is not allowed.\n - If the provided `annualRate` is outside of the range defined on the loan type, the system will accept the `annualRate` but will return a warning in the response's object `ratesValidation`.\n\n`spread` - interest rates defined as `spread` will calculate an absolute rate by adding the relative loan rate (aka spread) provided in the\n`annualRate` attribute to the Index Interest Rate effective on the date the interest is accrued. In case the Index Interest Rate is not set,\nthe system will assume that the Index Interest Rate value is zero on the date the interest is accrued.\n - Negative interest spread `annualRate` value is allowed, but the system will default to zero if the addition of the Index Interest Rate still results in a negative rate.\n - If the calculated absolute rate, `annualRate` (aka spread) plus Index Interest Rate, is outside of the range defined on the loan type, the system will accept the\n `annualRate` but will return a warning in the response's object `ratesValidation`.\n", "title": "Interest rate" }, "InterestRateResponse": { "allOf": [ { "$ref": "#/components/schemas/InterestRate" }, { "properties": { "interestType": { "default": "absolute", "description": "The interest type. The interest type cannot be changed after the loan status changes to `originated` and onward.\nInterest rates defined as `spread` will calculate an absolute rate by adding the relative loan rate (aka spread)\nprovided here to the Index Interest Rate effective on the date the interest is accrued. In case the Index Interest\nRate is not set, the system will assume that the Index Interest Rate value is zero on the date the interest is accrued.\n\nInterest rates defined as `absolute` will use the value as provided here without adding the Index Interest Rate.\n", "enum": [ "absolute", "spread" ], "type": "string" } }, "type": "object" } ] }, "PromoRate": { "allOf": [ { "$ref": "#/components/schemas/LoanRate" } ], "description": "A promo rate on a loan. If the annual interest rate is 0.25 and the promo rate for the corresponding\nperiod is 0.05, the net interest rate after application of the promo rate would be 0.2.\n", "title": "Promo rate" }, "isEndExistingRatesFlag": { "properties": { "isEndExistingRates": { "default": false, "description": "If true, the system will set all existing rates that have `endDate=null` to the new rate's `startDate` minus one calendar day.\nUse this flag carefully as it might impact ALL existing rates. For example:\n\n - A loan has one existing rate of 0.05 with `startDate=2021-07-01` and `endDate=null`.\n - A new rate of 0.01 is added with `startDate=2021-08-05` and `isEndExistingRates=true`.\n - The rate of 0.05 will be updated, and the end date will be set to `endDate=2021-08-04`.\n\nNotes:\n\n - Only rates with `endDate=null` will be updated. If an existing rate has a defined end date, that rate will not be modified.\n - If an existing rate has `startDate` equal to the new rate, and `endDate=null`, the system will invalidate the existing rate vs. setting\n `endDate` to the new rate's `startDate` minus one calendar day. For example:\n\n - A loan has one existing rate of 0.05 with `startDate=2025-10-02` and `endDate=null`.\n - A new rate of 0.01 is added with `startDate=2025-10-02` and `isEndExistingRates=true`.\n - The rate of 0.05 will be invalidated because the `endDate` cannot be `2025-10-01`.\n", "type": "boolean" } }, "type": "object" }, "InterestRateValidationAfterOrig": { "properties": { "interestRateBelowMinOrZero": { "description": "`true` if the interest rate is below the minimum interest rate.\n", "readOnly": true, "type": "boolean" }, "interestRateExceedsMax": { "description": "`true` if the interest rate exceeds the maximum interest rate.\n", "readOnly": true, "type": "boolean" } }, "type": "object" }, "DueDatesRequest": { "properties": { "agreementDocumentId": { "description": "The document descriptor ID corresponding to the accepted loan term change agreement. This is required unless\n`previewMode=true` or `isShowRevisedTermsOnFrequencyChange=false` on the loan type.\n", "type": "string" }, "caseId": { "description": "An identifier for an existing case.\n", "type": "string" }, "dueDatesFrequency": { "default": "monthly", "description": "The frequency of due dates.", "enum": [ "weekly", "everyTwoWeeks", "twiceMonthly", "monthly", "singleTerm" ], "type": "string" }, "previewMode": { "default": false, "description": "In `previewMode=true`, the loan doesn't change, and no changes are saved to the database.", "type": "boolean" }, "sendNotice": { "$ref": "#/components/schemas/SendNoticeCancelAutopay" }, "specificDays": { "$ref": "#/components/schemas/SpecificDays" } }, "type": "object" }, "LoanFee": { "properties": { "amount": { "description": "The fee amount.", "format": "float", "type": "number" }, "createdDate": { "description": "**DEPRECATED ATTRIBUTE** Use `timestamps.createdAt`.**\n\nThe date on which the fee was created. Fees in scheduled status have `createdDate` but not `dynamicFeeDetails.chargeDate` because\nthey are not yet in the ledger. `originationFee` and `drawFee` are created and charged on the same day. `dynamicFee` can be created\nbut charged later.\n", "format": "date", "type": "string" }, "dueDate": { "description": "The date on which the fee is due.", "format": "date", "type": "string" }, "dynamicFeeDetails": { "description": "Additional details about the fee. This object was historically used for `type=dynamicFee` only, but now it is used for all fee types.\nSome attributes in this object are applicable only to `type=dynamicFee`. Please carefully read the description of each attribute.\n", "properties": { "apiName": { "$ref": "#/components/schemas/FeeApiName" }, "canceledBy": { "description": "Identifier of the `User` who canceled the fee.", "type": "string" }, "canceledDate": { "description": "The date a fee was canceled in the product timezone. `null` indicates an uncanceled fee.\nOnly applicable to `type=dynamicFee` fee.\n", "format": "date", "type": "string" }, "capitalizedAmount": { "description": "The amount of fee that was capitalized. Only applicable to `dynamicFee` fees.\n\nIf the fee `amount` is different from the `originalAmount`, it can happen for a few reasons:\n 1. The fee amount was changed and the loan was replayed. In that case, both `capitalizedAmount` and `creditedAmount` attributes are not used. This is only possible for `originationFee` or `drawFee` fees.\n 2. Part or all of the fee amount was capitalized. In that case, the capitalized amount is represented by the `capitalizedAmount` attribute. This is only possible for `dynamicFee` fees.\n 3. Part or all of the fee amount was \"covered\" by a credit amount (also called `reimbursementAmount`) available on the line of credit. In that case, the credited amount is represented by the `creditedAmount` attribute. This is only possible for `dynamicFee` fees. Only applicable to lines of credit.\n\nFor `dynamicFee`, if `capitalizedAmount` and `creditedAmount` are not `null`, the follow equation should be true:\n`originalAmount - amount = capitalizedAmount + creditedAmount`\n", "format": "float", "nullable": true, "type": "number" }, "caseId": { "description": "An identifier for an existing case.", "type": "string" }, "chargeDate": { "description": "The date a fee was charged to the ledger in the product timezone.", "format": "date", "type": "string" }, "createdBy": { "description": "Identifier of the `User` who created the fee.\nOnly applicable to `type=dynamicFee` fee.\n", "type": "string" }, "creditedAmount": { "description": "The amount of the fee that was \"covered\" by a credit amount (also called `reimbursementAmount`) available on the line of credit. Only applicable to `dynamicFee` fees.\n\nIf the fee `amount` is different from the `originalAmount`, it can happen for a few reasons:\n 1. The fee amount was changed and the loan was replayed. In that case, both `capitalizedAmount` and `creditedAmount` attributes are not used. This is only possible for `originationFee` or `drawFee` fees.\n 2. Part or all of the fee amount was capitalized. In that case, the capitalized amount will be represented by the `capitalizedAmount` attribute. This is only possible for `dynamicFee` fees.\n 3. Part or all of the fee amount was \"covered\" by a credit amount (also called `reimbursementAmount`) available on the line of credit. In that case, the credited amount will be represented by the `creditedAmount` attribute. Only applicable to lines of credit. This is only possible for `dynamicFee` fees.\n\nFor `dynamicFee`, if `capitalizedAmount` and `creditedAmount` are not `null`, the follow equation should be true:\n`originalAmount - amount = capitalizedAmount + creditedAmount`\n", "format": "float", "nullable": true, "type": "number" }, "displayName": { "$ref": "#/components/schemas/FeeDisplayName" }, "loanFeeExternalId": { "description": "The lender's external identifier of the loan fee object in the system, can also be used to cancel the fee.\nOnly applicable to `type=dynamicFee` fee.\n", "type": "string" }, "loanFeeId": { "description": "The identifier of the loan fee in the system, used to cancel a fee if necessary.\nOnly applicable to `type=dynamicFee` fee.\n", "type": "string" }, "purchaseId": { "description": "The ID of the line of credit draw's purchase; only relevant for the following fee types: `foreignTransactionFee`, `purchaseFee`.\nOnly applicable to `type=dynamicFee` fee.\n", "type": "string" }, "transactionId": { "description": "The ID of the transaction; only relevant for the following fee types: `nsfFee`. Only applicable to `type=dynamicFee` fee.\n", "type": "string" } }, "type": "object" }, "loanId": { "$ref": "#/components/schemas/AnyId", "description": "The identifier of the loan that the fee is charged on." }, "originalAmount": { "description": "The original fee amount is calculated as the lower of:\n - The original fee amount when the fee was charged.\n - The updated amount if \"Update dynamic fee\" was called and originalAmount was passed. The updated amount cannot be higher than the amount when the fee was charged.\nSometimes fee amounts are adjusted, such as when a borrower pays off the fee before the statement date, as well as when the borrower has an overpayment in the ledger.\n", "format": "float", "type": "number" }, "scheduledDate": { "description": "The date when the fee is expected to be charged. This date is different from the `chargedDate` and `dueDate`.\nThis date should be used only for fees in `status=scheduled`.\n", "format": "date", "type": "string" }, "status": { "description": "- `scheduled` - the fee is expected to be charged in the future.\n- `booked` - the fee was charged and is in the ledger.\n- `modified`- the fee was charged, but the amount might have changed since it was booked.\n- `canceled` - the fee was canceled, and the borrower is no longer expected to pay it.\n", "enum": [ "scheduled", "booked", "modified", "canceled" ], "type": "string" }, "timestamps": { "properties": { "createdAt": { "description": "The timestamp when the fee was created in the system. Created does not mean booked / charged.\nA fee in `scheduled` status should have `createdAt`, `scheduledDate` and `dueDate`, but not `dynamicFeeDetails.chargeDate`.\nThis is because the fee is not in the ledger yet.\n", "format": "date-time", "type": "string" } }, "type": "object" }, "type": { "enum": [ "originationFee", "drawFee", "dynamicFee" ], "type": "string" } }, "type": "object" }, "FeesMigrationDetails": { "description": "Fees migration related details. This object should be used for lines that are migrated from another system to Peach.\nDon't use it for installment loan migration.\n", "properties": { "originalDrawId": { "description": "The draw identifier. Can be Peach or lender's external identifier.\n\nAll past fees prior to the \"migration cutoff date\" will be posted on the \"migration\" draw. After the \"migration cutoff date\",\na lender can have multiple draws (e.g. Purchases, Cash Withdrawals, etc.). Use this attribute to indicate the original\ndraw ID that the fee was posted on in another system.\n\nIn case of fee cancellation after the \"migration cutoff date\", the `originalDrawId` will be used to adjust the draw balance.\nFees can be posted on the line or draw level. If the `originalDrawId` is empty, the system will assume that the fee was\noriginally charged on the line level.\n", "nullable": true, "pattern": "^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\\d+$", "type": "string" }, "originalPurchaseId": { "description": "The purchase identifier. Can be Peach or lender's external identifier. Use this attribute to indicate the original purchase ID\nthat the fee was associated with in another system.\n\nOnly applicable to the following fee types: `foreignTransactionFee`, `purchaseFee`. The `originalPurchaseId` must be provided\nfor those fee types.\n", "type": "string" }, "originalTransactionId": { "description": "The transaction identifier. Can be Peach or lender's external identifier. Use this attribute to indicate the original\ntransaction ID (in `failed` status) that the fee was associated with in another system.\n\nOnly applicable to the following fee types: `nsfFee`. The `originalTransactionId` must be provided for those fee types.\n", "type": "string" } }, "type": "object" }, "LoanInvestors": { "properties": { "effectiveDate": { "description": "The date at which this ownership structure came into effect.", "format": "date", "type": "string" }, "investors": { "items": { "$ref": "#/components/schemas/LoanInvestor" }, "type": "array" } }, "title": "Investors", "type": "object" }, "schemas-SendNoticeCancelAutopay": { "default": true, "description": "When set to `false`, the system will NOT send a `loanPaymentScheduleChanged` notice to the borrower.\n", "type": "boolean" }, "LoanChangeLoanTermsSCRAUpdate": { "properties": { "caseId": { "description": "An identifier for an existing case.", "type": "string" }, "endDate": { "description": "The new end date for the SCRA period. The end date is inclusive.\nMust be within the loan's lifetime, after the start date, and must not overlap with other SCRA plans.\n", "format": "date", "type": "string" }, "rateId": { "description": "The public ID of the SCRA interest rate to modify.", "type": "string" }, "sendNotice": { "$ref": "#/components/schemas/schemas-SendNoticeCancelAutopay" }, "startDate": { "description": "The new start date for the SCRA period. The start date is inclusive.\nMust be within the loan's lifetime and must not overlap with other SCRA plans.\n", "format": "date", "type": "string" } }, "required": [ "rateId", "startDate", "endDate" ], "type": "object" }, "LoanChangeLoanTermsSCRA": { "properties": { "annualRate": { "default": 0.06, "description": "The annual interest rate for the period defined. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate.", "format": "float", "type": "number" }, "caseId": { "description": "An identifier for an existing case.", "type": "string" }, "endDate": { "description": "The end date of the period. The end date is inclusive.\n", "format": "date", "nullable": true, "type": "string" }, "isCancelFees": { "default": true, "description": "When set to `true`, the system will waive any fees that were charged during the period.", "type": "boolean" }, "sendNotice": { "$ref": "#/components/schemas/schemas-SendNoticeCancelAutopay" }, "startDate": { "description": "The start date of the period. The start date is inclusive.\n", "format": "date", "type": "string" } }, "required": [ "startDate", "endDate" ], "type": "object" }, "BasePastPeriod": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "dueDate": { "description": "The period's payment due date.", "format": "date", "nullable": false, "type": "string" }, "endDate": { "description": "The period end date. The end date is inclusive.", "format": "date", "nullable": false, "type": "string" }, "gracePeriod": { "nullable": true, "properties": { "fullBalanceAmount": { "description": "This attribute is only used for grace period benefit logic.\nThis amount is the full statement balance amount (also called \"new balance\") as of the date when the obligation is\n\"sealed\" (aka when `isOpen` is set to `false`).\nLine of credit (and Draw) obligations are \"sealed\" on the statement date.\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "nullable": true, "type": "number" }, "fullBalanceMinusOverdueAmount": { "description": "This attribute is only used for grace period benefit logic.\nThis amount is the full statement balance amount (also called \"new balance\") minus any overdue amount as of the\ndate when the obligation is \"sealed\" (aka when `isOpen` is set to `false`). Line of credit (and Draw) obligations are\n\"sealed\" on the statement date.\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "nullable": true, "type": "number" }, "isGracePeriodEligible": { "description": "The grace period status of the obligation period.\n`true` - means that the period is/was eligible for the grace period benefit and interest didn't accrue in the period.\n`false` - means that the period was not eligible for the grace period benefit and interest accrued in the period.", "type": "boolean" }, "totalFulfilledOnDueDateAmount": { "description": "This value is only used for grace period benefit logic. The value will be set one calendar day after the due date.\nThe amount of the obligation for the period fulfilled by service credits and borrower payments as of the end of the\ndue date. This is a sum of `fulfilledAmount` and `overpaymentsAmount`.\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "nullable": true, "type": "number" } }, "type": "object" }, "startDate": { "description": "The period start date. The start date is inclusive.", "format": "date", "nullable": false, "type": "string" }, "statementDate": { "description": "The date when a statement for the period was created or should be created in the future.", "format": "date", "nullable": false, "type": "string" } }, "type": "object" } ] }, "Statement": { "properties": { "creditBalanceAmount": { "description": "The total amount that a lender owes to the borrower.\nNote: Peach system does not allow negative balances. Use `creditBalanceAmount` to represent credit balance owed to the borrower.\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "documentDescriptorId": { "description": "The statement's document descriptor ID.\n", "nullable": true, "type": "string" }, "minimumAmountDue": { "description": "The minimum or recurring amount due for this period (also called obligation). This amount is a sum of interest\naccrued, fees and part of a principal. This amount does not net any payments or service credits made in the period.\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "newBalanceAmount": { "description": "The new balance amount for the period.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" } }, "type": "object" }, "PastPeriod": { "allOf": [ { "$ref": "#/components/schemas/BasePastPeriod" }, { "properties": { "statement": { "$ref": "#/components/schemas/Statement" } }, "type": "object" } ] }, "StatementWithRequired": { "properties": { "creditBalanceAmount": { "description": "The total amount that a lender owes to the borrower.\nNote: Peach system does not allow negative balances. Use `creditBalanceAmount` to represent credit balance owed to the borrower.\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "documentDescriptorId": { "description": "The statement's document descriptor ID.\n", "nullable": true, "type": "string" }, "minimumAmountDue": { "description": "The minimum or recurring amount due for this period (also called obligation). This amount is a sum of interest\naccrued, fees and part of a principal. This amount does not net any payments or service credits made in the period.\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "newBalanceAmount": { "description": "The new balance amount for the period.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" } }, "required": [ "minimumAmountDue", "newBalanceAmount" ], "type": "object" }, "PastPeriodWithRequireds": { "allOf": [ { "$ref": "#/components/schemas/PastPeriod" }, { "properties": { "statement": { "allOf": [ { "type": "object" }, { "$ref": "#/components/schemas/StatementWithRequired" } ] } }, "required": [ "startDate", "endDate", "statementDate", "dueDate", "statement" ], "type": "object" } ] }, "TransactionStatusReadOnly": { "enum": [ "scheduled", "initiated", "pending", "succeeded", "failed", "canceled", "inDispute", "chargeback" ], "type": "string" }, "PastTransactionMigrationDetails": { "properties": { "migration": { "description": "Transaction migration related details. This object:\n\n- Can be used only for transactions with an effective date before the \"migration cutoff date\".\n- Can be used for lines that are migrated from another system to Peach. Don't use it for installment loan migration.\n- Allows you to pass details on how a transaction was applied/allocated to draws.\n\nFor example:\n\nLine of credit had three draws prior to the \"migration cutoff date\". Balances of draws were:\n- Draw A: $650\n- Draw B: $70\n- Draw B: $0\n\nA payment of $120 was processed. Using this object you can tell the system that $120 was waterfalled/allocated as following:\n- Draw A split: $70\n- Draw B split: $50\n- Draw A split: $0\n\nIf you don't pass the `migration` object, then you won't be able to make the following status changes after the \"migration cutoff date\":\n`pending` → `failed`\n`succeeded` → `failed`\n", "properties": { "drawSplitDetails": { "description": "The transaction draw level split details are useful if the lender expects failures of previous successful transactions.\nWhen a transaction is applied on the line of credit level, it flows according to the payment waterfall configuration across\nmultiple draws. At least one element in the `drawSplitDetails` array is required.\n", "items": { "properties": { "drawAllocatedAmount": { "description": "The portion/split of the transaction `actualAmount` that was applied/allocated to the `originalDrawId` draw. The sum of all\n`drawAllocatedAmount` must be equal to the transaction's `amount`.\n\nIf the transaction fails after the \"migration cutoff date\", the system will increase the applicable \"originalDrawId\" draw's\nnon-due principal balance and replay the line.\n", "format": "float", "type": "number" }, "originalDrawId": { "description": "The draw identifier. Can be Peach or lender's external identifier.\n\nAll past transactions prior to the \"migration cutoff date\" will be posted on the \"migration\" draw. After the \"migration cutoff date\",\na lender can have multiple draws (e.g. Purchases, Cash Withdrawals, etc.) Use this attribute to indicate the original draw ID that\nthe transaction was posted on in another system. In case of transaction failure after the \"migration cutoff date\", the `originalDrawId`\nwill be used to increase the draw's \"non-due principal\" balance.\n\nTransactions can be posted on the line or draw level. If the transaction was originally posted on the draw level, choose one of the\npost migration draws (e.g. Purchases).\n", "pattern": "^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\\d+$", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "title": "Migration details", "type": "object" }, "PastTransactionResponse": { "allOf": [ { "$ref": "#/components/schemas/Transaction" }, { "$ref": "#/components/schemas/PastTransactionMigrationDetails" } ] }, "PastTransactionsPaging": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/PastTransactionResponse" }, "type": "array" } }, "type": "object" } ], "title": "Past transactions" }, "BaseOneTimePaymentTransaction": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "actualAmount": { "description": "The actual amount that was processed. The system never debits\nmore than the loan outstanding balance.\n", "readOnly": true, "type": "number" }, "amount": { "description": "The amount of the payment.\n", "format": "float", "minimum": 0, "type": "number", "writeOnly": true }, "createdBy": { "description": "Identifier of the user responsible for creating the transaction.\nCan be a borrower, service agent or automated system process (such as Autopay).\n", "readOnly": true, "type": "integer" }, "customDisplayName": { "description": "A friendly description of the transaction. If provided, this value will be displayed in Peach UI/App and Statements \n(or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements logic will \nrender the transaction name based on type and status. Make sure you provide value that makes sense to the borrower.\nThis is NOT what the borrower will see in their online bank or card account.\n", "nullable": true, "type": "string" }, "evidenceDocumentId": { "allOf": [ { "$ref": "#/components/schemas/AnyId" }, { "description": "The document ID of a one-time payment consent screenshot\ncaptured when a borrower made the payment. Only applicable when\nPeach App is used and company's\n`config.evidence.captureScreenshot=true`.\n" } ] }, "externalId": { "$ref": "#/components/schemas/externalId", "description": "A lender's identifier for a transaction." }, "failureReason": { "description": "The transaction failure reason. This value is ignored except when creating an external transaction with `status=failed`", "enum": [ "insufficientFunds", "chargeback", "accountClosed", "invalidAccount", "unknownReason", "invalidCvv", "invalidExpirationDate", "avsFailed", "networkError", "cardDeclined", "accountFrozen", "deceased", "invalidRouting", "paymentStopped", "incorrectNumber", "fraudulent", "unauthorizedDebit" ], "type": "string" }, "paymentInstrumentId": { "$ref": "#/components/schemas/AnyId", "description": "The payment instrument identifier that was charged." }, "scheduledAmount": { "description": "The scheduled amount. The actual amount charged can be lower from the\nscheduled amount. It cannot be higher.\n", "readOnly": true, "type": "number" }, "type": { "enum": [ "oneTime" ], "type": "string", "writeOnly": true } }, "required": [ "amount", "type" ], "type": "object" } ], "title": "One Time Payment" }, "PastTransactionCreationStatus": { "description": "The transaction status. May only be passed when `isExternal=true`.\n\nExternal transactions can be created in: `scheduled`, `initiated`, `pending`, `succeeded`, or `failed`.\nExternal transactions are applied to the loan balance immediately when created with status `initiated`, `pending`, or `succeeded`. Otherwise,\nthey will be applied the first time they are updated to one of these statuses.\n\n`initiated` - payment was initiated and sent to a payment processor. The payment is applied to a loan. This status is used normally for ACH.\n\n`pending` - payment was acknowledged by the payment processor and is being processed. For ACH the payment can be in pending status for a few days.\n\n`succeeded` - payment was completed successfully.\n\n`failed` - payment failed and was removed from the loan effective as of `initiated`, `pending` or `succeeded` status effective date. The system replays the loan as if the payment never happened.\nIt will also re-accrue interest since then.\n\n`inDispute` - payment is in dispute (typically because of chargeback). The payment is removed from the loan effective as of `initiated`, `pending` or `succeeded` status effective date. The system replays the loan as if the payment never happened.\nIt will also re-accrue interest since then. Disputed payment can be for partial amount.\n\n`canceled` - payment or credit was canceled. Payment can be canceled only if the current status is `scheduled`.\n\n`chargeback` - payment was disputed and ruled against the lender. The payment was returned to the original payment instrument. Chargeback payment can be for partial amount.\n", "enum": [ "initiated", "pending", "succeeded", "failed", "canceled", "inDispute", "chargeback" ], "type": "string" }, "BasePastTransaction": { "allOf": [ { "properties": { "effectiveDate": { "description": "This attribute can be used only during the migration process of loans from another system to Peach. Any value passed for `active` loans will be ignored.\n\nThe effective date of the transaction in the product timezone. Set `effectiveDateTimeInUtc` to `true` to interpret as UTC instead. This attribute can be used for transactions with `isExternal=true` only.\nThe date must be in the past or today. Make sure to provide `effectiveTimeOfDay` also.\n", "format": "date", "type": "string" }, "effectiveDateTimeInUtc": { "default": false, "description": "When `true`, `effectiveDate` and `effectiveTimeOfDay` are interpreted as UTC\nrather than the product timezone. This avoids ambiguity during DST transitions.\n", "type": "boolean" }, "effectiveTimeOfDay": { "allOf": [ { "$ref": "#/components/schemas/TimeOfDay" }, { "description": "The effective time of day on `effectiveDate` in the product timezone. Set `effectiveDateTimeInUtc` to `true` to interpret as UTC instead. This attribute can be used for transactions with `isExternal=true` only. Required if `effectiveDate` is passed.\n\nNote: for migration only, the value must be after 2AM in the product timezone.\n", "type": "object", "writeOnly": true } ] }, "paymentInstrumentDetails": { "description": "Payment instrument details are only allowed to be passed for migrated lines of credit. This allows you to create transactions\nwithout the need to create a payment instrument object first. If the `paymentInstrumentDetails` is passed, the system will not\nrequire `paymentInstrumentId`. Instead, the system will automatically create a payment instrument behind the scenes.\nThe instrument will be created as `instrumentType=paymentNetwork` and mainly used to be displayed in the Borrower Portal or an\nApp. The instrument cannot be used for any future transactions after the migration.\n", "properties": { "accountLastFour": { "description": "The last four digits of the payment instrument, check number, wire number, money order serial number or custom.\n", "maxLength": 4, "minLength": 4, "nullable": true, "type": "string" }, "customDisplayName": { "description": "Required only if `instrumentType=custom`. The system will show the payment method as `{customerDisplayName} *{accountLastFour}`.\nThe `customerDisplayName` will be adjusted automatically to uppercase. If the `accountLastFour` is not passed, the system will only\nshow the `{customerDisplayName}`.\n\nExample 1:\n instrumentType = custom\n customerDisplayName = Cash\n accountLastFour = empty\n Displayed as: `CASH`\n\nExample 2:\n instrumentType = bankAccount\n accountLastFour = 8892\n Displayed as: `BANK ACCOUNT *8892`\n\nExample 3:\n instrumentType = debitCard\n accountLastFour = 7098\n Displayed as: `DEBIT CARD *7098`\n", "nullable": true, "type": "string" }, "type": { "description": "The instrument type.", "enum": [ "bankAccount", "creditCard", "debitCard", "check", "payroll", "moneyOrder", "wire", "custom" ], "type": "string" } }, "type": "object" } }, "required": [ "effectiveDate", "effectiveTimeOfDay" ], "type": "object" }, { "$ref": "#/components/schemas/PastTransactionMigrationDetails" } ], "title": "Base Past Transaction" }, "PastTransactionOneTimePayment": { "allOf": [ { "$ref": "#/components/schemas/BaseOneTimePaymentTransaction" }, { "properties": { "status": { "$ref": "#/components/schemas/PastTransactionCreationStatus" } }, "required": [ "status" ], "type": "object" }, { "$ref": "#/components/schemas/BasePastTransaction" } ], "title": "One Time Payment" }, "BaseServiceCreditTransaction": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "actualAmount": { "description": "The actual amount that was processed. The system never debits\nmore than the loan outstanding balance.\n", "format": "float", "readOnly": true, "type": "number" }, "amount": { "description": "The amount to credit the borrower's balance.\n", "format": "float", "minimum": 0, "type": "number", "writeOnly": true }, "createdBy": { "description": "Identifier of the user responsible for creating the transaction.\nCan be a borrower, service agent or automated system process (such as Autopay).\n", "readOnly": true, "type": "integer" }, "customDisplayName": { "description": "A friendly description of the transaction. If provided, this value will be displayed in Peach UI/App and Statements \n(or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements logic will \nrender the transaction name based on type and status. Make sure you provide value that makes sense to the borrower.\nThis is NOT what the borrower will see in their online bank or card account.\n", "nullable": true, "type": "string" }, "externalId": { "$ref": "#/components/schemas/externalId" }, "scheduledAmount": { "description": "The scheduled amount. The actual amount charged can be lower from the\nscheduled amount. It cannot be higher.\n", "format": "float", "readOnly": true, "type": "number" }, "serviceCreditSponsor": { "description": "Sponsor of the credit. Mainly used for ledger/accounting.\n\nIf `loanOwner`, the credit is recorded as expense in ledger/accounting.\n\nIf `loanServicer`, the credit is recorded as liability from the servicer.\n\nIf `merchant`, the credit is recorded as liability from the merchant.\n", "enum": [ "loanOwner", "loanServicer", "merchant" ], "type": "string" }, "serviceCreditType": { "$ref": "#/components/schemas/serviceCreditTypes", "description": "Type of the credit. Credit types are recorded differently in ledger/accounting." }, "status": { "description": "The transaction status.\n\n`scheduled` - payment or credit was scheduled for a future date that has not arrived yet. The payment has not applied to a loan yet.\n\n`initiated` - payment was initiated and sent to a payment processor. The payment is applied to a loan. This status is used normally for ACH.\n\n`pending` - payment was acknowledged by the payment processor and is being processed. For ACH the payment can be in pending status for a few days.\n\n`succeeded` - payment was completed successfully.\n\n`failed` - payment failed and was removed from the loan effective as of `initiated`, `pending` or `succeeded` status effective date. The system replays the loan as if the payment never happened.\nIt will also re-accrue interest since then.\n\n`inDispute` - payment is in dispute (typically because of chargeback). The payment is removed from the loan effective as of `initiated`, `pending` or `succeeded` status effective date. The system replays the loan as if the payment never happened.\nIt will also re-accrue interest since then. Disputed payment can be for partial amount.\n\n`canceled` - payment or credit was canceled. Payment can be canceled only if the current status is `scheduled`.\n\n`chargeback` - payment was disputed and ruled against the lender. The payment was returned to the original payment instrument. Chargeback payment can be for partial amount.\n", "enum": [ "scheduled", "initiated", "pending", "succeeded", "failed", "canceled", "inDispute", "chargeback" ], "readOnly": true, "type": "string" }, "timestamps": { "description": "Timestamps of the transaction statuses.", "properties": { "canceledAt": { "format": "date-time", "type": "string" }, "chargebackAt": { "format": "date-time", "type": "string" }, "effectiveDate": { "format": "date", "type": "string" }, "failedAt": { "format": "date-time", "type": "string" }, "inDisputeAt": { "format": "date-time", "type": "string" }, "initiatedAt": { "format": "date-time", "type": "string" }, "pendingAt": { "format": "date-time", "type": "string" }, "scheduledDate": { "format": "date", "type": "string" }, "succeededAt": { "format": "date-time", "type": "string" } }, "readOnly": true, "type": "object" }, "type": { "enum": [ "service" ], "type": "string", "writeOnly": true } }, "required": [ "amount", "type", "serviceCreditType", "serviceCreditSponsor" ], "type": "object" } ], "title": "Service Credit" }, "PastTransactionServiceCredit": { "allOf": [ { "$ref": "#/components/schemas/BaseServiceCreditTransaction" }, { "$ref": "#/components/schemas/BasePastTransaction" } ], "title": "Service Credit" }, "BaseDownPaymentTransaction": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "actualAmount": { "description": "The actual amount that was processed. The system never debits\nmore than the loan outstanding balance.\n", "readOnly": true, "type": "number" }, "amount": { "description": "The amount of the payment.\n", "format": "float", "minimum": 0, "type": "number", "writeOnly": true }, "createdBy": { "description": "Identifier of the user responsible for creating the transaction.\nCan be a borrower, service agent or automated system process (such as Autopay).\n", "readOnly": true, "type": "integer" }, "customDisplayName": { "description": "A friendly description of the transaction. If provided, this value will be displayed in Peach UI/App and Statements \n(or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements logic will \nrender the transaction name based on type and status. Make sure you provide value that makes sense to the borrower.\nThis is NOT what the borrower will see in their online bank or card account.\n", "nullable": true, "type": "string" }, "externalId": { "$ref": "#/components/schemas/externalId", "description": "A lender's identifier for a transaction." }, "paymentInstrumentId": { "$ref": "#/components/schemas/AnyId", "description": "The payment instrument identifier that was charged." }, "scheduledAmount": { "description": "The scheduled amount. The actual amount charged can be lower from the\nscheduled amount. It cannot be higher.\n", "readOnly": true, "type": "number" }, "type": { "enum": [ "downPayment" ], "type": "string", "writeOnly": true } }, "required": [ "amount", "type" ], "type": "object" } ], "title": "Down Payment" }, "PastTransactionDownPayment": { "allOf": [ { "$ref": "#/components/schemas/BaseDownPaymentTransaction" }, { "properties": { "status": { "$ref": "#/components/schemas/PastTransactionCreationStatus" } }, "required": [ "status" ], "type": "object" }, { "$ref": "#/components/schemas/BasePastTransaction" } ], "title": "Down Payment" }, "PastTransaction": { "oneOf": [ { "$ref": "#/components/schemas/PastTransactionOneTimePayment" }, { "$ref": "#/components/schemas/PastTransactionServiceCredit" }, { "$ref": "#/components/schemas/PastTransactionDownPayment" } ] }, "BasePastTransactionForUpdate": { "allOf": [ { "properties": { "effectiveDate": { "description": "This attribute can be used only during the migration process of loans from another system to Peach. Any value passed for `active` loans will be ignored.\n\nThe effective date of the transaction in the product timezone. Set `effectiveDateTimeInUtc` to `true` to interpret as UTC instead. This attribute can be used for transactions with `isExternal=true` only.\nThe date must be in the past or today. Make sure to provide `effectiveTimeOfDay` also.\n", "format": "date", "type": "string" }, "effectiveDateTimeInUtc": { "default": false, "description": "When `true`, `effectiveDate` and `effectiveTimeOfDay` are interpreted as UTC\nrather than the product timezone. This avoids ambiguity during DST transitions.\n", "type": "boolean" }, "effectiveTimeOfDay": { "allOf": [ { "$ref": "#/components/schemas/TimeOfDay" }, { "description": "The effective time of day on `effectiveDate` in the product timezone. Set `effectiveDateTimeInUtc` to `true` to interpret as UTC instead. This attribute can be used for transactions with `isExternal=true` only. Required if `effectiveDate` is passed.\n\nNote: for migration only, the value must be after 2AM in the product timezone.\n", "type": "object", "writeOnly": true } ] }, "paymentInstrumentDetails": { "description": "Payment instrument details are only allowed to be passed for migrated lines of credit. This allows you to create transactions\nwithout the need to create a payment instrument object first. If the `paymentInstrumentDetails` is passed, the system will not\nrequire `paymentInstrumentId`. Instead, the system will automatically create a payment instrument behind the scenes.\nThe instrument will be created as `instrumentType=paymentNetwork` and mainly used to be displayed in the Borrower Portal or an\nApp. The instrument cannot be used for any future transactions after the migration.\n", "properties": { "accountLastFour": { "description": "The last four digits of the payment instrument, check number, wire number, money order serial number or custom.\n", "maxLength": 4, "minLength": 4, "nullable": true, "type": "string" }, "customDisplayName": { "description": "Required only if `instrumentType=custom`. The system will show the payment method as `{customerDisplayName} *{accountLastFour}`.\nThe `customerDisplayName` will be adjusted automatically to uppercase. If the `accountLastFour` is not passed, the system will only\nshow the `{customerDisplayName}`.\n\nExample 1:\n instrumentType = custom\n customerDisplayName = Cash\n accountLastFour = empty\n Displayed as: `CASH`\n\nExample 2:\n instrumentType = bankAccount\n accountLastFour = 8892\n Displayed as: `BANK ACCOUNT *8892`\n\nExample 3:\n instrumentType = debitCard\n accountLastFour = 7098\n Displayed as: `DEBIT CARD *7098`\n", "nullable": true, "type": "string" }, "type": { "description": "The instrument type.", "enum": [ "bankAccount", "creditCard", "debitCard", "check", "payroll", "moneyOrder", "wire", "custom" ], "type": "string" } }, "type": "object" } }, "type": "object" }, { "$ref": "#/components/schemas/PastTransactionMigrationDetails" } ], "title": "Update Past Transaction" }, "PastTransactionUpdate": { "allOf": [ { "$ref": "#/components/schemas/BasePastTransactionForUpdate" }, { "properties": { "amount": { "description": "The amount of the payment.\n", "format": "float", "minimum": 0, "type": "number" }, "externalId": { "$ref": "#/components/schemas/externalId" }, "failureReason": { "$ref": "#/components/schemas/TransactionFailureReason" }, "status": { "$ref": "#/components/schemas/PastTransactionCreationStatus" } }, "type": "object" } ] }, "LOCMigrationBalances": { "description": "The balances passed here should be as of the \"migration cutoff date\" after the most recent statement was generated in your legal system.\n\nFor example:\n- Migration period:\n - startDate: Aug 1, 2024\n - endDate: Aug 31, 2024\n - statementDate: Sep 1, 2024\n - dueDate: Sep 22, 2024\n- Previous period (also called \"past period\"):\n - startDate: Jul 1, 2024\n - endDate: Jul 31, 2024\n - statementDate: Aug 1, 2024\n - dueDate: Aug 22, 2024\n- Notes:\n - The balances should be as of Aug 1, 2024 after the statement was generated on Aug 1, 2024.\n", "properties": { "creditLimitAmount": { "description": "The line credit limit amount as of the \"migration cutoff date\".\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "dueBalances": { "description": "Due balances represent balances that are currently due.\nOnly fees can be passed inside the balance objects on LOC level.\nAll other balances are expected to be passed in the `Create migration period draw data` endpoint.\n", "properties": { "dueLateFeesAmount": { "description": "The late fees portion of `dueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "dueOriginationFeesAmount": { "description": "The origination fees portion of `dueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" } }, "required": [ "dueOriginationFeesAmount", "dueLateFeesAmount" ], "type": "object" }, "nonDueBalances": { "description": "Non-due balances represent balances that are not yet due.\nOnly fees can be passed inside the balance objects on LOC level.\nAll other balances are expected to be passed in the `Create migration period draw data` endpoint.\n", "properties": { "nonDueLateFeesAmount": { "description": "The late fees portion of `nonDueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "nonDueOriginationFeesAmount": { "description": "The origination fees portion of `nonDueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" } }, "required": [ "nonDueOriginationFeesAmount", "nonDueLateFeesAmount" ], "type": "object" }, "overdueBalances": { "description": "Overdue balances represent balances that are overdue.\nOnly fees can be passed inside the balance objects on LOC level.\nAll other balances are expected to be passed in the `Create migration period draw data` endpoint.\n", "properties": { "overdueLateFeesAmount": { "description": "The late fees portion of `overdueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" }, "overdueOriginationFeesAmount": { "description": "The origination fees portion of `overdueFeesAmount`.", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" } }, "required": [ "overdueOriginationFeesAmount", "overdueLateFeesAmount" ], "type": "object" }, "reimbursementAmount": { "description": "The total amount that a lender owes to the borrower as of the \"migration cutoff date\".\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "type": "number" } }, "required": [ "nonDueBalances", "dueBalances", "overdueBalances", "creditLimitAmount", "reimbursementAmount" ], "type": "object" }, "LOCMigrationGracePeriod": { "allOf": [ { "$ref": "#/components/schemas/BaseMigrationGracePeriod" }, { "description": "If you are not migrating past periods and the migration period is the first period of the LOC:\n\nDon't pass the `gracePeriod` object.\n\nIf you are migrating past periods:\n\nThis is the entire LOC grace period details including all its draws.\n\nThe grace period data passed here corresponds to the previous period and not to the migration period. By the time you call this endpoint, you should have already created one or more past periods. The additional data that you pass here is only required for the previous period and not for all past periods. That's why the grace period data is part of the \"Create migration period LOC data\" vs \"Create past periods data\" endpoint.\n\nThe migration period is a \"live\" period in which you execute migration.\n - Because the Peach system needs to know if the LOC is eligible for the grace period benefit when the migration period starts, the system\n will use the `isGracePeriodEligible` passed here. If you pass `isGracePeriodEligible=true`, the system will start migration without\n accruing interest in the \"migration period\". If you pass `isGracePeriodEligible=false`, the system will start migration with accruing\n interest in the \"migration period\".\n - On the \"due date + 1\" within the \"migration period\", the system evaluates the grace eligibility based on `fullBalanceAmount`, `fullBalanceMinusOverdueAmount` and payments made.\n - If you migrate the LOC before the upcoming \"due date\", the system will evaluate the grace period eligibility in \"live\" and might revoke the benefit.\n - If you migrate the LOC after the \"due date\", the system will evaluate the grace period eligibility as part of the \"replay/migration\" process.\n Because of existing limitations with \"replay\", grace period eligibility cannot be revoked as part of the replay process. However, the replay\n process can reinstate the grace period benefit (in other words, waive accrued interest from the start of the \"migration period\").\n - Peach is responsible for generating the statement corresponding to the migration period on `migrationPeriod.statementDate` in the future.\n The grace period details of the migration period will be calculated by the Peach system on `migrationPeriod.statementDate` in the future.\n\nFor example:\n- Migration period:\n - startDate: Aug 1, 2024\n - endDate: Aug 31, 2024\n - statementDate: Sep 1, 2024\n - dueDate: Sep 22, 2024\n- Previous period (also called \"past period\"):\n - startDate: Jul 1, 2024\n - endDate: Jul 31, 2024\n - statementDate: Aug 1, 2024\n - dueDate: Aug 22, 2024\nNotes:\n - The grace period details that you need to pass correspond to the previous period that started on Jul 1, 2024 and ended on Jul 31, 2024.\n - The amounts and values should be as of the \"migration cutoff date\", Aug 1, 2024, after the statement was finalized in your legacy system.\n", "type": "object" } ] }, "MigrationPeriod": { "description": "The migration period.\nThe \"migration cutoff date\" will be set to the `startDate` passed here. It's important to understand that `migrationPeriod.statementDate` and `migrationPeriod.dueDate` are future dates. The previous period's `dueDate` is also a future date (relative to when you execute the migration) and falls in the \"migration period\".\n\nFor example:\n- Migration period:\n - startDate: Aug 1, 2024\n - endDate: Aug 31, 2024\n - statementDate: Sep 1, 2024\n - dueDate: Sep 22, 2024\n- Previous period (also called \"past period\"):\n - startDate: Jul 1, 2024\n - endDate: Jul 31, 2024\n - statementDate: Aug 1, 2024\n - dueDate: Aug 22, 2024\nNotes:\n - \"Migration cutoff date\" is Aug 1, 2024.\n - If you execute the migration on Aug 10, 2024, the \"migration at date\" is Aug 10.\n - Previous period's `dueDate`, Aug 22, 2024, falls in the \"migration period\" that starts on Aug 1, 2024 and ends on Aug 31, 2024.\n - The upcoming due date is Aug 22, 2024.\n - If you didn't complete the migration before Aug 22, 2024, you need to cancel the loan and start the process again.\n", "properties": { "dueDate": { "format": "date", "nullable": false, "type": "string" }, "endDate": { "format": "date", "nullable": false, "type": "string" }, "id": { "readOnly": true, "type": "string" }, "object": { "default": "loanPeriod", "enum": [ "loanPeriod" ], "readOnly": true, "type": "string" }, "startDate": { "format": "date", "nullable": false, "type": "string" }, "statementDate": { "format": "date", "nullable": false, "type": "string" } }, "required": [ "startDate", "endDate", "statementDate", "dueDate" ], "type": "object" }, "LOCMigrationObligation": { "allOf": [ { "description": "If you are not migrating past periods and the migration period is the first period of the LOC:\n\nDon't pass the `obligation` object.\n\nIf you are migrating past periods:\n\nThis is the LOC level obligation details only (excluding any draws).\n\nThe data passed here corresponds to the previous period and not to the migration period. By the time you call this endpoint, you should've already created one or more past periods. The additional data that you pass here is only required for the previous period and not for all past periods. That's why the additional obligation data is part of the \"Create migration period LOC data\" vs \"Create past periods data\" endpoint.\n\nTo remind, the migration period is a \"live\" period in which you execute migration. The obligation details of the migration period will be calculated by the Peach system. Peach is also responsible for generating the statement corresponding to the migration period on `migrationPeriod.statementDate` in the future.\n\nFor example:\n - Migration period:\n - startDate: Aug 1, 2024\n - endDate: Aug 31, 2024\n - statementDate: Sep 1, 2024\n - dueDate: Sep 22, 2024\n - Previous period (also called \"past period\"):\n - startDate: Jul 1, 2024\n - endDate: Jul 31, 2024\n - statementDate: Aug 1, 2024\n - dueDate: Aug 22, 2024\n - Notes:\n - The obligation details that you need to pass correspond to the previous period that started on Jul 1, 2024 and ended on Jul 31, 2024.\n - The amounts and other values should be as of the \"migration cutoff date\", Aug 1, 2024, after the statement was finalized in your legacy system.\n", "properties": { "migratedDaysOverdue": { "$ref": "#/components/schemas/MigratedDaysOverdue" }, "migratedOverdueFromDate": { "description": "The date from which the account is overdue at the time of migration. This attribute will also\nbe used to calculate \"Date Of First Delinquency\" for credit bureaus reporting.\n\nIf `migratedDaysOverdue > 0`, then `migratedOverdueFromDate` is required.\n", "format": "date", "nullable": true, "type": "string" }, "obligationAmount": { "description": "The remaining amount of the previous period's obligation that a borrower needs to pay on the due date that comes after \"migration cutoff date\". The remaining amount should be as of \"migration cutoff date\" vs. \"migration at date\".\n\nThis is the LOC level remaining obligation amount excluding any draws' obligation amounts. Only fees can be passed inside the balance objects on LOC level. All other balances are expected to be passed in the `Create migration period draw data` endpoint.\n\nIf your LOC (or credit card) product doesn't count payments that were made before the statement date towards the statement minimum amount, then `obligationAmount` must be always equal to the LOC level portion of the whole statement minimum amount.\n\nExample:\n - Migration period:\n - startDate: Aug 1, 2024\n - endDate: Aug 31, 2024\n - statementDate: Sep 1, 2024\n - dueDate: Sep 22, 2024\n - Previous period (also called \"past period\"):\n - startDate: Jul 1, 2024\n - endDate: Jul 31, 2024\n - statementDate: Aug 1, 2024\n - dueDate: Aug 22, 2024\n\nScenario 1:\n - A late fee of $15 was charged in the previous period on Jul 23, 2024 (on the LOC level). This fee is due on Aug 22, 2024. \n - A borrower made some payments in the previous period, and based on your waterfall configuration in the legacy system, $5 out of $15 of the late fee was paid.\n - The remaining fee amount of $10 is due on Aug 22, 2024.\n - You should pass `obligationAmount=10`.\n\nScenario 2:\n - A late fee of $15 was charged in the previous period on Jul 23, 2024 (on LOC level). This fee is due on Aug 22, 2024. \n - A borrower made some payments in the previous period, and based on your waterfall configuration in the legacy system, none of the payments were counted toward the $15 late fee.\n - The late fee amount of $15 is due on Aug 22, 2024.\n - You should pass `obligationAmount=15`.\n\nScenario 3:\n - A late fee of $15 was charged in the previous period on Jul 23, 2024 (on LOC level). This fee is due on Aug 22, 2024. \n - A borrower made early payments in the previous period, and based on your waterfall configuration in the legacy system, the payments were counted toward the $15 late fee.\n - The remaining fee amount of $0 is due on Aug 22, 2024 (in other words, the borrower doesn't need to pay anything on Aug 22, 2024.)\n - You should pass `obligationAmount=0`.\n", "format": "float", "minimum": 0, "multipleOf": 0.01, "nullable": false, "type": "number" } }, "required": [ "obligationAmount", "migratedDaysOverdue" ], "type": "object" } ] }, "MigrationPeriodLOCData": { "properties": { "balances": { "$ref": "#/components/schemas/LOCMigrationBalances" }, "gracePeriod": { "$ref": "#/components/schemas/LOCMigrationGracePeriod" }, "migrationPeriod": { "$ref": "#/components/schemas/MigrationPeriod" }, "obligation": { "$ref": "#/components/schemas/LOCMigrationObligation" }, "postMigrationLoanChargedOffReason": { "description": "The reason for the line charge off. Only required if `migrationStatus=chargedOff`.\n- `term` means the loan was charged off per loan type configuration after X days overdue.\n- `fraudulent` means the loan was charged off for a fraudulent reason.\n- `bankruptcy` means the loan was charged off because of bankruptcy.\n- `legal` means the loan was charged off because of some legal reason.\n", "enum": [ "term", "fraudulent", "bankruptcy", "legal" ], "nullable": true, "type": "string" }, "postMigrationLoanStatus": { "default": "active", "description": "The status of the line after a successful migration.\nIf you pass `accelerated` or `chargedOff`, the system will first migrate the line as \"active\" and then\nimmediately accelerate or charge off the line and its draws. The `effectiveDate` of the acceleration\nor charge off will be equal to the \"migration cutoff date\".\n", "enum": [ "active", "accelerated", "chargedOff" ], "type": "string" } }, "type": "object" }, "MigrationPeriodLOCDataResponse": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MigrationPeriodLOCData" }, { "properties": { "migratedOverdueAmount": { "format": "float", "nullable": true, "type": "number" } }, "type": "object" } ] } }, "type": "object" } ] }, "MigrationPeriodLOCDataWithRequired": { "allOf": [ { "$ref": "#/components/schemas/MigrationPeriodLOCData" }, { "required": [ "migrationPeriod", "obligation", "gracePeriod", "balances" ], "type": "object" } ] }, "ObligationLoanGracePeriod": { "description": "Loan's grace period details. Only Loans created with `isGracePeriodEligible=true` will populate details in this object.\nSee `gracePeriod` object for Draw-specific grace period details.\n", "nullable": true, "properties": { "fullBalanceAmount": { "description": "This attribute is only used for grace period benefit logic.\nThis amount is the full statement balance amount (also called \"new balance\") as of the date when the obligation is\n\"sealed\" (aka when `isOpen` is set to `false`).\nLine of credit (and Draw) obligations are \"sealed\" on the statement date.\n", "format": "float", "nullable": true, "type": "number" }, "fullBalanceMinusOverdueAmount": { "description": "This attribute is only used for grace period benefit logic.\nThis amount is the full statement balance amount (also called \"new balance\") minus any overdue amount as of the\ndate when the obligation is \"sealed\" (aka when `isOpen` is set to `false`). Line of credit (and Draw) obligations are\n\"sealed\" on the statement date.\n", "format": "float", "nullable": true, "type": "number" }, "isGracePeriodEligible": { "description": "The grace period status of the obligation period.\n`true` - means that the period is/was eligible for the grace period benefit and interest didn't accrue in the period.\n`false` - means that the period was not eligible for the grace period benefit and interest accrued in the period.", "type": "boolean" }, "totalFulfilledOnDueDateAmount": { "description": "This value is only used for grace period benefit logic. The value will be set one calendar day after the due date.\nThe amount of the obligation for the period fulfilled by service credits and borrower payments as of the end of the\ndue date. This is a sum of `fulfilledAmount` and `overpaymentsAmount`.\n", "format": "float", "nullable": true, "type": "number" } }, "type": "object" }, "LOCObligationResult": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "$ref": "#/components/schemas/ObligationAmountFields" }, { "$ref": "#/components/schemas/ObligationOtherFields" }, { "properties": { "gracePeriod": { "anyOf": [ { "description": "Draws' grace period details. Only draws that were created with `isGracePeriodEligible=true` will be included in the list.\n", "items": { "allOf": [ { "properties": { "drawId": { "description": "The draw identifier.", "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/ObligationGracePeriod" } ] }, "nullable": true, "type": "array" }, { "$ref": "#/components/schemas/ObligationGracePeriod" } ] }, "loanGracePeriod": { "$ref": "#/components/schemas/ObligationLoanGracePeriod" } }, "type": "object" } ] }, "LOCObligationsResult": { "allOf": [ { "$ref": "#/components/schemas/IsLocked" }, { "properties": { "daysOverdue": { "description": "Number of calendar days overdue starting from the due date of the earliest overdue obligation to\nthe current date.\n", "type": "integer" }, "isOverdue": { "description": "`true` if the borrower has any obligation overdue on the loan.\n", "type": "boolean" }, "obligations": { "items": { "$ref": "#/components/schemas/LOCObligationResult" }, "type": "array" }, "overdueAmount": { "description": "The total overdue amount across all obligations on the loan.\n", "format": "float", "type": "number" } }, "type": "object" } ] }, "LoanChangeLoanTerms": { "allOf": [ { "$ref": "#/components/schemas/DueDatesRequest" }, { "properties": { "duration": { "description": "The remaining duration - in months starting from the current day - under the new payment plan.\n", "type": "integer" }, "recurringAmount": { "description": "The requested recurring amount under the new payment plan.\n", "format": "float", "type": "number" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ] }, "LoanPeriod": { "properties": { "dueDate": { "description": "The period's payment due date in the product timezone.", "format": "date", "type": "string" }, "endDate": { "description": "The period end date in the product timezone. The end date is inclusive.", "format": "date", "type": "string" }, "id": { "description": "The period identifier.", "type": "string" }, "startDate": { "description": "The period start date in the product timezone. The start date is inclusive.", "format": "date", "type": "string" }, "statementDate": { "description": "The date when a statement for the period was created or should be created in the future.", "format": "date", "type": "string" } }, "type": "object" }, "LoanPeriodsPaging": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LoanPeriod" }, "type": "array" } }, "type": "object" }, "ProcessingCompleteGeneric": { "properties": { "processingComplete": { "description": "Only returned when query parameter `sync` is set to `true`. Indicates if the extra processing has finished yet.\nIf it is not done in 20 seconds, the request will return and this value will be set to `false`.\n", "type": "boolean" } }, "type": "object" }, "StatementSharedFields": { "properties": { "billingCycleEndDate": { "description": "The end date of the statement billing cycle. This date is in the product timezone.", "format": "date", "type": "string" }, "billingCycleStartDate": { "description": "The start date of the statement billing cycle. This date is in the product timezone.", "format": "date", "type": "string" }, "documentDescriptorId": { "description": "The statement's document descriptor ID. To get the actual document, use the \"Download document content\" endpoint.\n", "type": "string" }, "isExternal": { "description": "If `true`, it means that the statement was originally calculated and created in another system (not in Peach) and\nuploaded to the Peach system. Statements with `isExternal=true` might not have all statement details data.\nYou must upload a PDF version of the statement. Statements that are marked as `isExternal=true` cannot\nbe regenerated by Peach. The system will return an error if the regenerate statement endpoint\nis called for a statement with `isExternal=true` value.\n\nIf `false`, it means that the statement was originally calculated and created by the Peach system.\n\nUsed in Line of Credit migration.\n", "readOnly": true, "type": "boolean" }, "minimumDueAmount": { "description": "The minimum or recurring amount due for this period (also called obligation). This amount is a sum of interest accrued,\nfees and part of a principal. This amount does not net any payments or service credits made in the period.\n\nIf `loanType.statements.includeOverdueAmountInMinPayment` = `true`, the minimum payment calculation will include\nthe minimum amount calculated for the closed period and overdue amount from previous periods.\n", "format": "float", "type": "number" }, "newBalanceAmount": { "description": "The new balance amount for the period.", "format": "float", "type": "number" }, "paymentDueDate": { "description": "The due date of the statement. This date is in the product timezone.", "format": "date", "type": "string" }, "periodId": { "description": "The period identifier.", "type": "string" }, "reason": { "description": "If this statement was regenerated due to replay, the replay reason supplied by the user.", "nullable": true, "type": "string" }, "replayId": { "description": "If this statement was regenerated due to replay, the ID of the replay.", "nullable": true, "type": "string" }, "statementDate": { "description": "The statement date. This date is in the product timezone.", "format": "date", "type": "string" }, "statementLogicVersion": { "default": 3, "description": "The statement logic version. When a new statement is generated, it will use the current loan type `statementLogicVersion` value.\nThat version is also stored on each statement object. When/if the statement is regenerated, it will use the\n`statementLogicVersion` value from the statement object vs. loan type. This guarantees that the system uses the same\nlogic as the original statement.\n\n- Version `1` - first/original statement logic. All loan types created before the release of the version `3`, would be set to `1`. When a lender is ready, they can ask Peach to upgrade to version `3`. All statements that were generated before the release of version `3` would be marked as version `1` or `2`.\n- Version `2` - second statement logic that was introduced in Q2 2024. This is a deprecated version and should not be used.\n- Version `3` - third statement logic that was introduced in Q4 2024.\n", "type": "integer" }, "userId": { "description": "If this statement was regenerated due to replay, the ID of the user that initiated the replay.", "nullable": true, "type": "string" }, "version": { "description": "The version of the statement. When a statement is updated, we don't delete the old version.\nWe create a new version of the statement. The most recent version of the statement is returned.\n", "type": "integer" } }, "type": "object" }, "schemas-Statement": { "allOf": [ { "properties": { "createdAt": { "description": "The timestamp (UTC) of when the statement was created.", "format": "date-time", "readOnly": true, "type": "string" }, "deletedAt": { "description": "The timestamp (UTC) of when the statement was deleted.\n", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "id": { "description": "The statement's unique identifier.", "readOnly": true, "type": "string" }, "updatedAt": { "description": "The timestamp (UTC) of when the statement was updated. On update, the system will create a new version of the statement.\n", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/StatementSharedFields" } ] }, "RequestStartDate": { "description": "The start date of the promise to pay plan. If `startDate` is not provided upon promise to pay plan creation,\nthe system will use the created date (i.e. \"today\") as the `startDate`. If `startDate` is provided, it must be a date in the future.\nNotes:\n- If you are providing a `schedule` object, you should not pass the `startDate`. In case both are provided in the \n request, a `400 Bad Request error` will be returned.\n- If Peach's system creates the schedule based on `frequency`,`specificDays` and `duration` passed, the system will \n schedule Promise to Pay Periods starting after the `startDate`.\n", "format": "date", "type": "string" }, "PromiseToPayPlanPost": { "properties": { "amount": { "description": "Amount required to be fulfilled for each period of the promise to pay plan. Peach's system will use the amount\nprovided to trigger any required promise `status` transitions.\n\nNote: \n- If `amount` is passed to the endpoint, ensure that `frequency` and `duration` are also provided.\n- If you are providing an `amount` object, you should not pass the `schedule`. In case both are provided in the \n request, a `400 Bad Request error` will be returned.\n", "format": "float", "minimum": 0.01, "type": "number" }, "caseId": { "description": "The ID of the case associated with the promise to pay plan.", "nullable": true, "type": "string" }, "duration": { "description": "The duration of the promise to pay plan as a number of `frequency` periods. For example:\nif `frequency=weekly` and `duration=6`, the promise will be created with 6 weeks duration and will have 6 \nperiods all with the same amount.\n\nNote: \n- If `duration` is passed to the endpoint, ensure that `frequency` and `amount` are also provided.\n- If you are providing a `duration` object, you should not pass the `schedule`. In case both are provided in the \n request, a `400 Bad Request error` will be returned.\n", "minimum": 1, "type": "integer" }, "externalId": { "$ref": "#/components/schemas/ExternalId" }, "frequency": { "description": "The agreed payment frequency of the promise. Peach's system will use the desired frequency to create promise to pay period(s) so the lender can monitor progress against promised payment dates and amount paid. \n`weekly`, `everyTwoWeeks`, `twiceMonthly`, and `monthly` options create multiple promise to pay periods, according to the `duration`.\n`singleTerm` creates a promise with a single period and desired duration of X calendar days or a specific date that should be passed in `specificDays`. \n\nNote: \n- If `frequency` is passed to the endpoint, ensure that `duration` and `amount` are also provided.\n- If you are providing a `frequency` object, you should not pass the `schedule`. In case both are provided in the \n request, a `400 Bad Request error` will be returned.\n", "enum": [ "weekly", "everyTwoWeeks", "twiceMonthly", "monthly", "singleTerm" ], "type": "string" }, "previewMode": { "default": false, "description": "In `previewMode=true`, the Promise to Pay Plan and corresponding Promise Period Objects will be\nreturned for preview without committing the object to database\n", "type": "boolean" }, "schedule": { "description": "To create a custom promise to pay schedule with varying amounts or irregular periods, pass a `schedule` when \ncreating the promise to pay plan. \nNote:\nEither `schedule` object or schedule descriptor attributes (`startDate`, `frequency`, `specificDays` \n, 'duration' and 'amount') can be passed to create a promise to pay plan. In case both are provided in the \nrequest, a `400 Bad Request error` will be returned.\n", "items": { "properties": { "amount": { "description": "The promised amount.\n", "format": "float", "minimum": 0.01, "type": "number" }, "dueDate": { "description": "The due date of the promised amount.\n", "format": "date", "type": "string" } }, "type": "object" }, "type": "array" }, "sendNotice": { "default": true, "description": "When set to `true`, Peach's system will send a notice to the borrower about the promise to pay plan.\nNote: If `sendNotice` is not passed, the system will default to `true`.\n", "type": "boolean" }, "specificDays": { "description": "Specific days designate the day(s) that due dates will fall on. The allowed values for specific\nday(s) depends on the `paymentFrequency`.\n\n`weekly` - provide one number in the valid range 1-7. 1=Monday...7=Sunday.\n\nFor example: [1].\n\n`everyTwoWeeks` - provide two inputs. The first input (required) is an integer in the valid range 1-7. 1=Monday...7=Sunday.\n\nThe second input is a date that indicates when to start the cycle. If the second input is not passed, the system will default\nto the first valid start date based on the first input (the day of week passed in). If this date is provided then it can override\nthe minimum due date gap specified on the loan type.\n\nFor example: [1, \"2020-09-16\"].\n\n`twiceMonthly` - provide two numbers in the valid range 1-31. 1=first day of a month. Use 31 to\nindicate the last day of a month.\n\nFor example: [1, 15] or [15, 31].\n\n`monthly` - provide one number in the valid range 1-31. 1=first day of a month. Use 31 to indicate\nthe last day of a month.\n\nFor example: [1].\n\n`singleTerm` - provide one number to indicate duration as a number of calendar days or provide a valid calendar date in the\nfuture. For example: [90] or [\"2020-09-16\"].\n\nFor `weekly`, `everyTwoWeeks`, `twiceMonthly`, `monthly`:\nIf specificDays is left null, then the system will calculate due dates according to the paymentFrequency relative\nto the origination or activation date (or use existing specific days in the case of change due date).\n\nFor `singleTerm`:\nThe specificDays is mandatory.\n", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "nullable": true, "type": "array" }, "startDate": { "$ref": "#/components/schemas/RequestStartDate" } }, "type": "object" }, "PromiseToPayPlanCancel": { "properties": { "cancellationCaseId": { "description": "The case to associate with this promise to pay plan cancellation.", "nullable": true, "type": "string" }, "cancellationReason": { "description": "The reason for canceling the promise to pay plan.\n\n`canceledByUser` - Promise to pay plan was canceled by an agent or borrower.\n`loanChargedOff` - loan was charged off during the promise period.\n`loanAccelerated` - loan was accelerated during the promise period.\n`otherPromisePlanOffered` - another promise plan was offered.\n`other` - for any other reason requiring cancellation.\n", "enum": [ "canceledByUser", "loanChargedOff", "loanAccelerated", "otherPromisePlanOffered", "other" ], "type": "string" }, "reasonDetails": { "description": "Additional details about the reason for canceling the promise to pay plan.\n", "nullable": true, "type": "string" } }, "required": [ "cancellationReason" ], "type": "object" }, "PromoProgramPaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "allOf": [ { "properties": { "promoPrograms": { "items": { "$ref": "#/components/schemas/PromoProgramResult" }, "type": "array" } }, "type": "object" } ] } }, "type": "object" } ] }, "PromoProgramPut": { "allOf": [ { "$ref": "#/components/schemas/PromoProgramPutCommon" }, { "properties": { "status": { "description": "The promotional program status on a specific loan.\n\n `pending` - the promotion was created but was not\n activated yet.\n\n `active` - the promotion is active.\n\n `canceled` - the promotion has been canceled for a\n reason. The reason provided in the `promoCancelReason`\n attribute.\n\n `exercised` - the promotion was successfully\n exercised.\n", "enum": [ "pending", "active", "canceled", "exercised" ], "type": "string" } }, "type": "object" } ], "description": "Update a promo program" }, "PurchasesPaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Purchase" }, "type": "array" } }, "type": "object" } ] }, "RefundDetails": { "description": "The details of refund.", "properties": { "categoryId": { "description": "The category identifier of the refund.", "nullable": true, "type": "string" }, "description": { "default": "Refund", "description": "The description of the refund. Normally shown in Borrower Portal and on statements. At least one of the attributes, `description`\nor `merchantName` must be passed.\n", "nullable": true, "type": "string" }, "merchantId": { "description": "The merchant identifier that the refund was used for.", "nullable": true, "type": "string" }, "merchantName": { "description": "The merchant name that the refund was used for. At least one of the attributes, `description` or `merchantName` must be passed.", "nullable": true, "type": "string" }, "metadata": { "description": "Store any type of key/value pairs in the form of a JSON dictionary.", "nullable": true, "type": "object" }, "pointOfSaleType": { "description": "- `online` - the refund was made online on a website or in a mobile application.\n- `physical` - the refund was made in a store with a physical card or instrument.\n- `recurring` - the refund was made as part of a subscription service.\n", "enum": [ "online", "physical", "recurring" ], "type": "string" } }, "type": "object" }, "LoanRefundTimestamps": { "properties": { "canceledAt": { "format": "date-time", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "readOnly": true, "type": "object" }, "LoanRefund": { "properties": { "atFaultParty": { "description": "The party at fault for the refund. Mainly used for ledger/accounting.\n\nIf `loanOwner`, the lender is billed for the entire refund, and paid interest and fees are refunded to the borrower.\n\nIf `loanServicer`, the servicer is billed for the entire refund, and paid interest and fees are refunded to the borrower.\n\nIf `merchant`, the merchant is billed for the entire refund, and paid interest and fees are refunded to the borrower.\n\nIf `borrower`, the merchant is billed for the entire refund, and the borrower receives no refund for paid interest and fees.\n", "enum": [ "loanOwner", "loanServicer", "merchant", "borrower" ], "type": "string" }, "caseId": { "description": "The case identifier.", "type": "string" }, "isFullRefund": { "description": "`true` if the refund is a full refund, `false` if the amount is a partial refund.\n", "readOnly": true, "type": "boolean" }, "originalAmount": { "description": "The original amount of the refund. The amount must be positive.", "format": "float", "readOnly": true, "type": "number" }, "refundAmount": { "description": "The refund amount. The maximum eligible refund amount is the `amountFinancedAtOrigination` of the loan. The refund is applied against the principal of the loan.\n", "exclusiveMinimum": true, "format": "float", "minimum": 0, "type": "number" }, "refundDate": { "description": "This attribute can be set only during the migration process of loans from another system to Peach. Any value passed for `active` loans will be ignored.\n\nThe refund effective date in the product timezone. If not provided, the refund will be recorded in the ledger with an effective timestamp of the `Create refund` call.\n", "format": "date", "type": "string" }, "refundDetails": { "$ref": "#/components/schemas/RefundDetails" }, "sendNotice": { "default": true, "description": "When set to `false`, the system will NOT send a `loanRefundProcessed` notice to the borrower.", "type": "boolean", "writeOnly": true }, "timestamps": { "$ref": "#/components/schemas/LoanRefundTimestamps" } }, "required": [ "refundAmount", "atFaultParty" ], "type": "object" }, "LoanRefundCollectionResponse": { "properties": { "eligibleRefundAmount": { "description": "The remaining amount eligible for refund. This is equal to the `amountFinancedAtOrigination` minus prior refund amounts.", "format": "float", "type": "number" }, "refunds": { "items": { "$ref": "#/components/schemas/LoanRefund" }, "type": "array" } }, "type": "object" }, "ReadOnlyInternalRefundDetails": { "allOf": [ { "$ref": "#/components/schemas/InternalRefundDetails" }, { "properties": { "refundNonDuePrincipalAmount": { "readOnly": true }, "refundTransactionAmount": { "readOnly": true }, "refundTransactionId": { "readOnly": true } }, "type": "object" } ] }, "RefundDetailsV2": { "allOf": [ { "$ref": "#/components/schemas/ReadOnlyInternalRefundDetails" }, { "properties": { "description": { "default": "Refund", "description": "The description of the refund. Normally shown in Borrower Portal and/or on statements.", "nullable": true, "type": "string" }, "merchantId": { "description": "The merchant identifier that the refund was used for.", "nullable": true, "type": "string" }, "merchantName": { "description": "The merchant name that the refund was used for.", "nullable": true, "type": "string" }, "metadata": { "description": "Store any type of key/value pairs in the form of a JSON dictionary.", "nullable": true, "type": "object" } }, "type": "object" } ] }, "LoanRefundV2": { "properties": { "atFaultParty": { "description": "The party at fault for the refund. Mainly used for ledger/accounting.\n\nIf `loanOwner`, the lender is billed (on accounting level) for the refund.\n\nIf `loanServicer`, the servicer is billed (on accounting level) for the refund.\n\nIf `merchant`, the merchant is billed (on accounting level) for the refund.\n\nIf `borrower`, the merchant is billed (on accounting level) for the refund.\n", "enum": [ "loanOwner", "loanServicer", "merchant", "borrower" ], "type": "string" }, "canceledBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for canceling the refund.\nCan be an agent or automated system process.\n" }, "cancellationCaseId": { "description": "The cancellation case identifier.", "readOnly": true, "type": "string" }, "cancellationReason": { "description": "The reason why the refund was canceled.\n\n`wrongAmountOrDetails` - the refund was created with the wrong amount or details.\n\n`processingError` - the refund could not be processed.\n\n`other` - any other reason why the refund was canceled.\n", "enum": [ "wrongAmountOrDetails", "processingError", "other" ], "readOnly": true, "type": "string" }, "cancellationReasonDetails": { "description": "The reason for refund cancellation. This is typically entered by an agent canceling a refund via the front end.", "readOnly": true, "type": "string" }, "caseId": { "description": "The case identifier.", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for creating the refund.\nCan be an agent or automated system process.\n" }, "externalId": { "description": "A lender's identifier for the refund.\n\nAfter the object is successfully created, a lender can use ID or externalId identifiers to fetch the object.\n\nTo fetch the object using `externalId` you need to add `ext-` to the URL.\n\nNote: Don't add ext- to the identifier value. For example: if the external identifier is `ABCDE`, then pass `externalId=ACBCE`\nand NOT `ext-ABCDE` when creating the object.\n", "minLength": 1, "nullable": true, "type": "string" }, "feesExceptionList": { "default": [], "description": "A list of the dynamic fees (aka LoanFee) identifiers that will not be refunded/canceled. The identifiers can be Peach or\nlender's external identifiers.\nThis allows lenders to exclude specific fees from being refunded.\nFor example:\n - `isRefundLateFees=true`\n - `feesExceptionList=[LF-K98P-NM3E]`\nThe system will refund/cancel all late fees except for `LF-K98P-NM3E`.\n", "items": { "type": "string" }, "type": "array" }, "id": { "readOnly": true, "type": "string" }, "isFullRefund": { "description": "`true` if the refund is a full refund, `false` if the amount is a partial refund.\n", "readOnly": true, "type": "boolean" }, "isRefundDownPayment": { "default": false, "description": "If `true`, the system will refund the down payment amount (assuming the down payment was paid by the borrower).\nOnly applicable if refunded for a full amount.\n", "type": "boolean" }, "isRefundLateFees": { "default": false, "description": "If `true`, the system will cancel any late fees charged after `refundDate + refundTimeOfDay`.\nIf `false`, the system will not cancel any late fees as part of the refund.\n", "type": "boolean" }, "isRefundMDR": { "default": false, "description": "If `true`, the system will record the prorated MDR amount to the merchant within the ledger.\nPeach is not involved in the settlement process with merchants, and will only record amounts in the ledger.\nOnly applicable if `refundDate` equals the activation date.\n", "type": "boolean" }, "isRefundOriginationFees": { "default": false, "description": "If `true`, the system will forego origination fee. Only applicable if the `refundDate` is the loan activation date.\nIf `false`, the system will not do anything with the origination fee as part of the refund.\n\nNote: refunding the origination fee is different from calling \"Update origination fee\" endpoint.\nWhen the origination fee is refunded, the system books the origination fees amount and move the entries to \"foregone\"\nimmediately after.\nWhen the origination fee amount is updated via `Update origination fee`, the system changes the origination fee amount,\nre-books the fee from the activation date and replays the loan.\n", "type": "boolean" }, "isRefundOtherFees": { "default": false, "description": "If `true`, the system will cancel any dynamic fees (except for late fees and fees listed in the `otherFeesExceptionList`)\ncharged after `refundDate + refundTimeOfDay`.\n\nIf `false`, the system will not cancel any dynamic fees (other than late fees and fees listed in the\n`otherFeesExceptionList`) as part of the refund.\n\nNote: if an account ends in `paidOff` status after the refund is applied, any service fees after the payoff date will\nbe canceled, regardless of the `isRefundOtherFees` value.\n", "type": "boolean" }, "originalAmount": { "description": "The original amount of the refund. The amount must be positive.", "format": "float", "readOnly": true, "type": "number" }, "refundAmount": { "description": "The refund amount. The maximum eligible refund amount is the `amountFinancedAtOrigination` of the loan. The refund is applied against the principal of the loan.\n", "exclusiveMinimum": true, "format": "float", "minimum": 0, "type": "number" }, "refundDate": { "description": "The refund effective date in the product timezone. The `refundDate` can be any date between the activation date and the current date.\nIf not provided, the refund will be recorded in the ledger with an effective timestamp of the `Create refund` call.\n\nTo make the refund effective from the beginning of the loan, please pass the activation date and don't pass `refundTimeOfDay`.\nIn this case, the system will create the refund immediately after the activation.\n", "format": "date", "type": "string" }, "refundDetails": { "$ref": "#/components/schemas/RefundDetailsV2" }, "refundTimeOfDay": { "allOf": [ { "$ref": "#/components/schemas/TimeOfDay" }, { "default": { "hour": 12, "minute": 1, "second": 0 } } ], "description": "The effective time of day on `refundDate` in the product timezone. The default value is 12:01:00 AM in the product timezone.\n\nNote: for migration only, the value must be after 2AM in the product timezone.\n", "writeOnly": true }, "sendNotice": { "default": true, "description": "When set to `false`, the system will NOT send a `loanRefundProcessed` notice to the borrower.", "type": "boolean", "writeOnly": true }, "status": { "description": "The status of the refund. - `settled` - the refund was successfully processed. - `processing` - the refund is being processed. Wait until the status changes to `succeeded` or `canceled`. - `canceled` - the refund was canceled or not processed.", "enum": [ "settled", "processing", "canceled" ], "nullable": true, "readOnly": true, "type": "string" }, "timestamps": { "$ref": "#/components/schemas/LoanRefundTimestamps" } }, "required": [ "refundAmount", "atFaultParty" ], "type": "object" }, "LoanRefundCancel": { "allOf": [ { "properties": { "cancellationReason": { "description": "Reason the refund was canceled.\n", "enum": [ "wrongAmountOrDetails", "processingError", "other" ], "type": "string" }, "cancellationReasonDetails": { "description": "The reason for refund cancellation. This is typically entered by an agent canceling a refund via the front end.\n", "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ] }, "properties-caseId": { "description": "An identifier for an existing case.", "type": "string" }, "LoanReimburse": { "properties": { "caseId": { "$ref": "#/components/schemas/properties-caseId" }, "contactId": { "description": "An identifier of an existing contact. Required if the `paymentInstrumentType` is `check` and the check is processed/sent by Peach.\n", "type": "string" }, "customDisplayName": { "description": "A friendly description of the transaction. If provided, this value will be displayed in Peach UI/App and Statements (or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements logic will render the transaction name based on type and status. Make sure you provide value that makes sense to the borrower.\nThis is NOT what the borrower will see in their online bank or card account.\n", "nullable": true, "type": "string" }, "externalTransactionId": { "description": "A transaction external identifier. If passed, the new reimbursement transaction that the system will create will have the `externalTransactionId`.", "type": "string" }, "isExternal": { "description": "If set to `true`, the lender assumes responsibility for transferring funds to the borrower. If set to `false`, Peach handles the transfer of funds to the borrower.", "type": "boolean" }, "paymentInstrumentId": { "description": "Peach's unique or lender's external identifier. Not required if the paymentInstrumentType=check and the check is processed/sent by Peach.", "pattern": "^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\\d+$", "type": "string" }, "paymentInstrumentType": { "enum": [ "bankAccount", "card", "check", "payroll", "paymentNetwork" ], "type": "string" }, "reimbursementAmount": { "description": "The requested reimbursement amount.", "format": "float", "type": "number" }, "transactionStatus": { "description": "Only applicable if isExternal=true. The status in which the new reimbursement transaction will be created. If the status is set to pending, the caller\ncan later update the transaction status via Update transaction endpoint. Only applicable if isExternal=true.\n", "enum": [ "pending", "succeeded" ], "type": "string" } }, "required": [ "paymentInstrumentType", "reimbursementAmount" ], "type": "object" }, "LoanReverseAccelerateResponse": { "properties": { "reversedAcceleratedAmount": { "description": "The amount of the acceleration reversal.", "format": "float", "type": "number" } }, "type": "object" }, "LoanReverseChargeOffResponse": { "properties": { "reversedChargeOffAmount": { "description": "The amount of the charge-off reversal.", "format": "float", "type": "number" } }, "type": "object" }, "EveryTwoWeeksOptions": { "properties": { "days": { "items": { "properties": { "date": { "format": "date", "type": "string" }, "day": { "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" }, "dayOfWeek": { "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "LoanScheduleOptions": { "properties": { "frequencyOptions": { "properties": { "everyTwoWeeks": { "$ref": "#/components/schemas/EveryTwoWeeksOptions" } }, "type": "object" } }, "type": "object" }, "StatementsPaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/schemas-Statement" }, "type": "array" } }, "type": "object" } ], "title": "statements" }, "StatementActivity": { "properties": { "activityType": { "description": "The activity type.\n", "enum": [ "fee", "payment", "paymentReversal", "credit", "creditReversal", "refund", "reimbursement", "purchase" ], "type": "string" }, "amount": { "description": "The amount of the activity.\n", "format": "float", "type": "number" }, "dateOfActivity": { "description": "The date the activity was posted.\n", "format": "date", "type": "string" }, "description": { "description": "The description of the activity.\n", "type": "string" }, "effectiveDate": { "description": "The effective date of the activity in the product timezone.\n", "format": "date", "type": "string" }, "referenceNumber": { "description": "The reference number or identifier of the activity.\n", "type": "string" } }, "type": "object" }, "StatementActivityV2": { "properties": { "activityType": { "description": "The activity type.\n", "enum": [ "fee", "payment", "paymentReversal", "credit", "creditReversal", "refund", "reimbursement", "purchase", "advance", "purchaseDispute", "cashback" ], "type": "string" }, "amount": { "description": "The effective amount of the activity that was applied in the ledger in the current or a past\nperiod. `amount` and `originalAmount` are expected to be equal unless something happened to\nthe activity after the activity was originally applied in the ledger.\n\nExample 1:\n - A payment was originally processed for $100.00 from the borrower's bank account.\n - Later, $30.00 was reversed (the $30.00 was sent back to the borrower's bank account).\n - The `amount` would be equal to $70.00.\n - The `originalAmount` would be equal to $100.00\n\nExample 2:\n - A service fee of $10.00 was supposed to be charged.\n - A line (e.g. credit card) had a credit balance of $3.50 (in other words, $3.50 was owed to a borrower).\n - The `amount` would be equal to $6.50.\n - The `originalAmount` would be equal to $10.00.\n\nIt's important to understand how `amount` is used to calculate either:\n - One of the \"total\" attributes such as `totalPaymentsForThisPeriod`.\n - Or, the `totalAdjustmentsForThisPeriod`.\n\nWhen `isAdjustment=false`, the `amount` is used to calculate one of the \"total\" attributes: `totalPaymentsForThisPeriod`, `totalFeesForThisPeriod`, etc.\n\nWhen `isAdjustment=true`, the `amount` is reflected in the `totalAdjustmentsForThisPeriod`. This is because\nthe reported activity impacted one of the past periods, the loan was replayed and the balance was adjusted.\nKeep in mind that `totalAdjustmentsForThisPeriod` is equal to sum of activities' `amount` and the\n`interestAdjustmentForThisPeriod`. For example:\n - A payment was originally processed for $100.00 two periods ago.\n - Later, the payment was disputed by a borrower and the chargeback was accepted for the full amount of $100.00.\n - If the line accrues interest, the `totalAdjustmentsForThisPeriod` would be different from $100.00 because additional interest was accrued.\n - The `amount` would be equal to $0.00.\n - The `originalAmount` would be equal to $100.00.\n - The `interestAdjustmentForThisPeriod` would be equal to $1.42.\n - The `totalAdjustmentsForThisPeriod` would be equal to $101.42.\n", "format": "float", "type": "number" }, "dateOfActivity": { "description": "The date when the activity was created. Also called \"transaction date\". Most activities will have `dateOfActivity` equals to `effectiveDate`.\n\nIn some cases, `dateOfActivity` can be different from `effectiveDate`. For example:\n - A credit card purchase was made and authorized on Mar 11, 2023.\n - The purchase was captured/settled on Mar 13, 2023.\n - dateOfActivity is Mar 11, 2023.\n - effectiveDate is Mar 13, 2023.\n", "format": "date", "type": "string" }, "description": { "description": "The description of the activity.\n", "type": "string" }, "displaySign": { "description": "The sign that should be displayed next to the amount.\n", "enum": [ "positive", "negative" ], "type": "string" }, "drawId": { "description": "The draw identifier that the activity belongs to. Only applicable to line of credit and the following activity types: `fee`, `purchase`, `purchaseDispute`.\n", "nullable": true, "type": "string" }, "effectiveDate": { "description": "The date when the activity was applied in the ledger in the product timezone. Also called \"post date\". Most activities will have `dateOfActivity` equals to `effectiveDate`.\n\nIn some cases, `dateOfActivity` can be different from `effectiveDate`. For example:\n - A credit card swipe/purchase was made and authorized on Mar 11, 2023.\n - The purchase was captured/settled on Mar 13, 2023.\n - `dateOfActivity` is Mar 11, 2023.\n - `effectiveDate` is Mar 13, 2023.\n", "format": "date", "type": "string" }, "isAdjustment": { "description": "`false` if the activity was originally applied in the ledger in the current period. In other words, it's not an adjustment of an activity that was already reported in a past period.\n\n`true` if the activity was reported in the current period but it impacted one of the past periods. In other words, the activity is a change or an adjustment of one of the prior activities that was reported in a past period.\nWhen an activity with an effective date in one of the past periods is reported, the balance impact is captured in the `totalAdjustmentsForThisPeriod` attribute. Keep in mind that `totalAdjustmentsForThisPeriod` can be different from the activity `amount`.\n\nExample:\n - A payment was originally processed for $100.00 two periods ago. That activity was reported as `isAdjustment=false`.\n - Later, the payment was disputed by a borrower and the chargeback was accepted for the full amount of $100.00. The chargeback activity would be reported as `isAdjustment=true`.\n - If the line accrues interest, the `totalAdjustmentsForThisPeriod` would be different from $100.00 because additional interest was accrued.\n - The `amount` would be equal to $0.00.\n - The `originalAmount` would be equal to $100.00.\n - The `amountForTotals` would be equal to $0.00.\n - The `totalAdjustmentsForThisPeriod` would be greater than $100.00.\n", "type": "boolean" }, "originalAmount": { "description": "The original amount of the activity that was applied in the ledger before any changes or adjustments.\n", "format": "float", "type": "number" }, "referenceNumber": { "description": "Peach Public ID of the underlying object that created the activity.\n", "type": "string" }, "referenceNumberExternal": { "description": "External ID of the underlying object that created the activity. If the corresponding object doesn't have an `externalId`, the attribute value will be `null`.\n", "nullable": true, "type": "string" } }, "type": "object" }, "BaseStatementDetails": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "$ref": "#/components/schemas/StatementSharedFields" }, { "properties": { "autopay": { "description": "The Autopay details at the time of statement generation. Note: Autopay plan can be canceled any time by the borrower, agent (on behalf of the borrower) or system (e.g. bank account closed).\n", "properties": { "paymentInstrumentId": { "description": "The payment instrument ID with which this autopay plan will be charged through.", "nullable": true, "type": "string" }, "schedule": { "items": { "properties": { "amount": { "description": "The amount of the expected payment.", "format": "float", "type": "number" }, "date": { "description": "The due date of the expected payment.", "format": "date", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "borrowerDetails": { "description": "The borrower details.\n", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "name": { "description": "The borrower name. If the borrower is a person, the value will be `firstName` + `lastName`.\nIf the borrower is a business, the value will be `businessName`.\n", "type": "string" } }, "type": "object" }, "creditBalanceAmount": { "description": "The total amount of money that the lender owes to the borrower.\n", "format": "float", "type": "number" }, "creditBalanceNetChangeAmount": { "description": "The net change amount of the `creditBalanceAmount` (also\ncalled `reimbursementAmount`) during the period.\n\nExample 1:\n\n - In the prior period `newBalanceAmount`=0 and\n `creditBalanceAmount`=100.\n - In the this period:\n - A new purchase or advance was made in amount of $35\n (`creditBalanceAmount` decreased by 35).\n - The `creditBalanceNetChangeAmount`=-35.\n\nExample 2:\n\n - In the prior period `newBalanceAmount`=0 and\n `creditBalanceAmount`=100.\n - In the this period:\n - A check in amount of $20 was posted\n (`creditBalanceAmount` increased by 20).\n - A new purchase or advance was made in amount of $35\n (`creditBalanceAmount` decreased by 35).\n - The `creditBalanceNetChangeAmount`=+20-35=-15.\n", "format": "float", "type": "number" }, "daysInBillingCycle": { "description": "The number of calendar days in the billing cycle (also called period).\n", "type": "integer" }, "fulfilledAmount": { "description": "The total amount of payments and service credits applied towards minimumAmountDue.", "format": "float", "type": "number" }, "interestAdjustmentForThisPeriod": { "description": "In some cases account balances can be adjusted because some event changed in the past. For example: late\nreturn of a payment which results in additional interest charged for a period in the past. When such\nadjustments are made this attribute reflects the net adjusted interest amount. The interest adjustment can\nbe positive or negative.\n", "format": "float", "nullable": true, "type": "number" }, "isDisplayLatePaymentWarning": { "description": "If `true`, the statement should show a special warning amount late fees - \"Late Payment Warning\" paragraph.\nIf the product type doesn't have any late fees the system will return `false`.\n", "type": "boolean" }, "lastPeriodFeesPaid": { "description": "Fees amount paid (by the borrower or via credit) in the statement corresponding period.\n", "format": "float", "type": "number" }, "lastPeriodInterestPaid": { "description": "Interest amount paid (by the borrower or via credit) in the statement corresponding period.\n", "format": "float", "type": "number" }, "lastPeriodOverPaid": { "description": "Excess amount paid (by the borrower or via credit) that was not allocated to principal,\ninterest or fees in the statement corresponding period.\n", "format": "float", "type": "number" }, "lastPeriodPrincipalPaid": { "description": "Principal amount paid (by the borrower or via credit) in the statement corresponding period.\n", "format": "float", "type": "number" }, "lastPeriodTotalPaid": { "description": "Total amount paid (by the borrower or via credit) in the statement corresponding period.\n", "format": "float", "type": "number" }, "lateFeeUpToAmount": { "description": "The maximum amount of late fee that can be charged in the period (if the borrower doesn't pay on time). The attribute will have value if `isDisplayLatePaymentWarning` is `true`.\n", "format": "float", "type": "number" }, "loanStatus": { "allOf": [ { "$ref": "#/components/schemas/LoanStatus" }, { "readOnly": true } ] }, "newPrincipalBalance": { "description": "Principal balance of the account as of the statement date and corresponding period.\n", "format": "float", "type": "number" }, "overdueAmount": { "description": "Overdue amount as of the statement date and corresponding period.\n", "format": "float", "type": "number" }, "overpaymentsAmount": { "description": "In the case that loan policy allows, this represents the amount of overpayments applied to the period. Overpayments will only arise when\nan obligation (aka `minimumAmountDue`) is completely fulfilled.\n", "format": "float", "type": "number" }, "previousBalance": { "description": "Previous statement balance (also called `newBalance`).\n", "format": "float", "type": "number" }, "previousCreditBalanceAmount": { "description": "The total amount of money that the lender owed to the borrower in the previous statement.\n", "format": "float", "type": "number" }, "promoPrograms": { "items": { "properties": { "description": { "description": "A legal description of the promotional program as it\nshould be communicated and shown to borrowers.\nIf the description is provided, borrowers will see\nthe description in the Borrower Portal.\n", "type": "string" }, "displayName": { "description": "The promotional program name as it is shown to\nborrowers.\n", "type": "string" }, "drawId": { "type": "string" }, "externalId": { "type": "string" }, "id": { "type": "string" }, "promoCancelReason": { "$ref": "#/components/schemas/PromoCancelReason" }, "promoEndDate": { "$ref": "#/components/schemas/PromoStartDate" }, "promoExercisedDate": { "format": "date", "type": "string" }, "promoStartDate": { "$ref": "#/components/schemas/PromoStartDate" }, "promoType": { "$ref": "#/components/schemas/PromoType" }, "remainingAmountToExercise": { "description": "Represents the remaining balance needed to be paid in\norder to exercise the promotional program.\n", "type": "number" }, "status": { "description": "The promotional program status on a specific loan.\n\n `pending` - the promotion was created but was not\n activated yet.\n\n `active` - the promotion is active.\n\n `canceled` - the promotion has been canceled for a\n reason.\n The reason provided in the `promoCancelReason`\n attribute.\n\n `exercised` - the promotion was successfully\n exercised.\n", "enum": [ "pending", "active", "canceled", "exercised" ], "type": "string" }, "totalDeferredInterestAmount": { "description": "The total deferred interest accrued.\nIf the deferred interest promotion is exercised, the\ndeferred interest is not expected to be paid.\nOnly for deferred interest promo programs.\n", "type": "number" } }, "required": [ "id", "status", "promoType" ], "type": "object" }, "type": "array" }, "remainingAmount": { "description": "The total amount remaining to be paid by the borrower after accounting for payments and service credits applied in the period.", "format": "float", "type": "number" }, "statementActivities": { "items": { "oneOf": [ { "$ref": "#/components/schemas/StatementActivity" }, { "$ref": "#/components/schemas/StatementActivityV2" } ] }, "type": "array" }, "statementLogicVersion": { "default": 3, "description": "The statement logic version. When a new statement is generated, it will use the current loan type `statementLogicVersion` value.\nThat version is also stored on each statement object. When/if the statement is regenerated, it will use the\n`statementLogicVersion` value from the statement object vs. loan type. This guarantees that the system uses the same\nlogic as the original statement.\n\n- Version `1` - first/original statement logic. All loan types created before the release of the version `3`, would be set to `1`. When a lender is ready, they can ask Peach to upgrade to version `3`. All statements that were generated before the release of version `3` would be marked as version `1` or `2`.\n- Version `2` - second statement logic that was introduced in Q2 2024. This is a deprecated version and should not be used.\n- Version `3` - third statement logic that was introduced in Q4 2024.\n", "type": "integer" }, "totalAdjustmentsForThisPeriod": { "description": "In some cases account balances can be adjusted because some event changed in the past.\nFor example: late return of a payment or interest changed for a period in the past.\nWhen such adjustments are made this attribute reflects the net adjusted amount.\n", "format": "float", "type": "number" }, "totalCreditReversalsForThisPeriod": { "description": "Total of credits reversed/canceled in the period.\n", "format": "float", "type": "number" }, "totalCreditsForThisPeriod": { "description": "Total of credits applied in the period.\n", "format": "float", "type": "number" }, "totalFeesForThisPeriod": { "description": "Total amount of fees charged in the period.\n", "format": "float", "type": "number" }, "totalInterestForThisPeriod": { "description": "For LOC:\n Total amount of interest accrued on draws in the period. The interest amount accrued on each draw is truncated to the nearest cent and\n the sum of the truncated values is reported by this field.\nFor installment loan:\n If the period is still open, the amount will be accrued interest in the period plus expected interest to be accrued until the due date.\n", "format": "float", "type": "number" }, "totalPaymentReversalsForThisPeriod": { "description": "Total of payments reversed/returned to the borrower in the period.\n", "format": "float", "type": "number" }, "totalPaymentsForThisPeriod": { "description": "Total of payments made in the period.\n", "format": "float", "type": "number" }, "totalRefundsForThisPeriod": { "description": "Total of refunds applied in the period.\n", "format": "float", "type": "number" }, "year": { "description": "The year of the statement. Year-to-date fields are calculated based on this value.\nUsually the `endDate` of the statement period is the reference for the year. The exception is when the `statementDate`\nis before the `endDate`, in which case `statementDate` is the reference for the year.\n", "type": "string" }, "yearToDateFeesCharged": { "description": "Total amount of fees charged in the current year from 01/01/YYYY to the statement date.\n", "format": "float", "type": "number" }, "yearToDateInterestCharged": { "description": "Total amount of interest charged in the current year from 01/01/YYYY to the statement date. This field is computed as the sum\nof the interest accrued by the draws on this line and then rounded to the nearest cent.\n", "format": "float", "type": "number" }, "ytdFeesPaid": { "description": "Fees amount paid (by the borrower or via credit) year to date, from 01/01/YYYY to the statement date.\n", "format": "float", "type": "number" }, "ytdInterestPaid": { "description": "Interest amount paid (by the borrower or via credit) year to date, from 01/01/YYYY to the statement date.\n", "format": "float", "type": "number" }, "ytdOverPaid": { "description": "Excess amount paid (by the borrower or via credit) that was not allocated to principal,\ninterest or fees year to date, from 01/01/YYYY to the statement date.\n", "format": "float", "type": "number" }, "ytdPrincipalPaid": { "description": "Principal amount paid (by the borrower or via credit) year to date, from 01/01/YYYY to the statement date.\n", "format": "float", "type": "number" }, "ytdTotalPaid": { "description": "Total amount paid (by the borrower or via credit) year to date, from 01/01/YYYY to the statement date.\n", "format": "float", "type": "number" } }, "type": "object" } ] }, "InstallmentStatementDetails": { "allOf": [ { "$ref": "#/components/schemas/BaseStatementDetails" }, { "properties": { "apr": { "description": "The effective APR.", "format": "float", "type": "number" }, "prepaidAmount": { "description": "Amount paid in the period prior to due date.\n", "format": "float", "type": "number" }, "recurringAmount": { "description": "The most recent amortized recurring amount.\n", "format": "float", "type": "number" }, "totalAdvancesForThisPeriod": { "description": "The total amount of advances made in the period.\n", "format": "float", "nullable": true, "type": "number" }, "totalAmountDue": { "description": "The total amount due for the period as of the time when the statement was generated. It represents the sum\nof the minimumAmountDue and overdueAmount minus any payments or service credits applied in the period.\n", "format": "float", "type": "number" } }, "title": "Installment", "type": "object" } ], "title": "Installment" }, "StatementDrawInfo": { "properties": { "apr": { "description": "The net interest rate (also called APR), interest rate minus promo rate, of the draw/sub-line as of the last day of the period (aka `billingCycleEndDate`).\n", "format": "float", "type": "number" }, "availableCredit": { "description": "Available credit for this specific draw.", "format": "float", "type": "number" }, "balanceEndOfPeriod": { "description": "The draw/sub-line remaining balance at the end of the period.\n", "format": "float", "type": "number" }, "creditLimit": { "description": "The credit limit amount for the draw.", "format": "float", "type": "number" }, "deferredInterestForThisPeriod": { "description": "The deferred interest accrued for this period only.\nIf the deferred interest promotion is exercised, the deferred interest\nis not expected to be paid.\n", "format": "float", "type": "number" }, "drawId": { "description": "The draw identifier.", "type": "string" }, "fulfilledAmount": { "description": "The total amount of payments and service credits applied towards `minAmountDue``.", "format": "float", "type": "number" }, "interestCharged": { "description": "The amount of interest accrued in the period. This value is computed by truncating (to the nearest cent) the interest accrued in this period.\nThis is amount is equal to the sum of `interestChargedDetails.interestCharged` amounts in the `interestChargedDetails` array.\n", "format": "float", "type": "number" }, "interestChargedDetails": { "description": "Details of interest charged in the period.", "items": { "properties": { "balanceSubjectToInterestRate": { "description": "The average balance of draw/sub-line that was subject to the `interestRate`. Calculated by adding the principal amount on days with `interestRate`\ndivided by `numberDays`. Also called Average Daily Balance.\n", "format": "float", "type": "number" }, "interestChargeType": { "description": "The type of interest charge.\n- `daily` - a standard daily accrual in the period.\n- `deferred` - deferred interest that was recognized/charged in the period. Note: the interest amount that was charged in the period \n is a total of deferred interest that was accrued across multiple periods.\n", "enum": [ "daily", "deferred" ], "type": "string" }, "interestCharged": { "description": "The net interest rate (also called APR). Calculated as interest rate minus promo rate of the draw/sub-line as of the last day of the period (aka the billingCycleEndDate).\n", "format": "float", "type": "number" }, "interestRate": { "description": "The net interest rate that the balance accrued interest for `numberDays`. If the draw has a single interest rate, the value is also called\nAPR of the draw/sub-line. If the draw was created in the middle of the period or was paid off before the period ended, the system will count\ndays as `interestRate=0`.\n", "format": "float", "type": "number" }, "numberDays": { "description": "Number of days in the period that principal was subject to the `interestRate`. Sum of `numberDays` in the array is equal to the number of days in the period.\n", "type": "integer" } }, "type": "object" }, "type": "array" }, "isVariableRate": { "description": "`true` if the rate is variable. `false` if the rate is fixed.\n", "type": "boolean" }, "minAmountDue": { "description": "The minimum amount due of the draw/sub-line for the period.\n", "format": "float", "type": "number" }, "nameOfBalance": { "description": "The name of the balance (also called draw/sub-line).\n", "type": "string" }, "overLimitAmount": { "description": "The amount by which the balance exceeded the credit limit for the draw. This amount is expected to be greater than 0 \nonly when the credit limit is exceeded.\n", "format": "float", "type": "number" }, "overpaymentsAmount": { "description": "In the case that loan policy allows, this represents the amount of overpayments applied to the period. Overpayments will only arise when an\nobligation (aka `minAmountDue`) is completely fulfilled.\n", "format": "float", "type": "number" }, "remainingAmount": { "description": "The total amount remaining to be paid by the borrower after accounting for payments and service credits applied in the period.", "format": "float", "type": "number" }, "totalDeferredInterestAmount": { "description": "The total deferred interest accrued.\nIf the deferred interest promotion is exercised, the deferred interest\nis not expected to be paid. Only for deferred interest promo programs.\n", "format": "float", "type": "number" }, "totalPurchasesForThisPeriod": { "description": "Total of new purchases on the draw in the period corresponding to the statement.\n", "format": "float", "type": "number" }, "utilizationAmount": { "$ref": "#/components/schemas/UtilizationAmount" } }, "type": "object" }, "LOCStatementDetails": { "allOf": [ { "$ref": "#/components/schemas/BaseStatementDetails" }, { "properties": { "authorizedPurchasesAmount": { "description": "The total amount of authorized purchases at the time of statement generation. This amount reduces `availableCredit`\nand `openToBuy`; is not included in the `newBalanceAmount`; and appears in the Account Summary section of the statement.\n", "format": "float", "nullable": true, "type": "number" }, "availableCredit": { "description": "Available credit to use.\n", "format": "float", "type": "number" }, "creditLimit": { "description": "The credit limit amount for the line or draw. Only applicable to line of credit or installment loan with multiple\nadvances. For installment loans with multi-advances, it is the amount financed set at origination.\n", "format": "float", "type": "number" }, "gracePeriod": { "deprecated": true, "description": " If `true`, the account is eligible for the benefits of \"grace period\".", "type": "boolean" }, "isDisplayMinimumPaymentWarning": { "description": "If `true`, the statement should show a special warning amount minimum payment - \"Minimum Payment Warning\" paragraph and table.\n", "type": "boolean" }, "locClosedDate": { "description": "The date LOC was closed in the product timezone. If LOC is closed, new purchases are not allowed. Closed LOC can still have outstanding balance.\n", "format": "date", "type": "string" }, "minimumPaymentWarning": { "description": "The details required to show the Minimum Payment Warning table in the statement.", "properties": { "comparedToDuration": { "description": "The number of years it should take to pay off the balance if the borrower pays the `comparedToPaymentAmount` only.\n*Per regulations*:\nIf the minimum payment repayment estimate is less than 2 years, the card issuer must disclose the estimate in months.\nOtherwise, the estimate must be disclosed in years and rounded to the nearest whole year.\n", "type": "integer" }, "comparedToDurationMonths": { "description": "The number of months it should take to pay off the balance if the borrower pays the `comparedToPaymentAmount` only.\n*Per regulations*:\nIf the minimum payment repayment estimate is less than 2 years, the card issuer must disclose the estimate in months.\nOtherwise, the estimate must be disclosed in years and rounded to the nearest whole year.\n", "type": "integer" }, "comparedToPaymentAmount": { "description": "The payment amount that the minimum amount is compared to.\n", "format": "float", "type": "number" }, "comparedToTotalCostAmount": { "description": "The estimated total amount (or cost) the borrower is expected to pay if the borrower pays the `comparedToPaymentAmount` only.\n", "format": "float", "type": "number" }, "minimumPaymentDuration": { "description": "The number of years it should take to pay off the balance if the borrower makes the minimum payment only.\n*Per regulations*:\nIf the minimum payment repayment estimate is less than 2 years, the card issuer must disclose the estimate in months.\nOtherwise, the estimate must be disclosed in years and rounded to the nearest whole year.\n", "type": "integer" }, "minimumPaymentDurationMonths": { "description": "The number of months it should take to pay off the balance if the borrower makes the minimum payment only.\n*Per regulations*:\nIf the minimum payment repayment estimate is less than 2 years, the card issuer must disclose the estimate in months.\nOtherwise, the estimate must be disclosed in years and rounded to the nearest whole year.\n", "type": "integer" }, "minimumPaymentTotalCostAmount": { "description": "The estimated total amount (or cost) the borrower is expected to pay if the borrower makes the minimum payment only.\n", "format": "float", "type": "number" } }, "type": "object" }, "statementDrawInfo": { "items": { "$ref": "#/components/schemas/StatementDrawInfo" }, "type": "array" }, "totalCashBacksForThisPeriod": { "description": "Total of cashBacks applied in the period.\n", "format": "float", "type": "number" }, "totalPurchasesForThisPeriod": { "description": "Total of new purchases in the period corresponding to the statement.\n", "format": "float", "type": "number" }, "utilizationAmount": { "$ref": "#/components/schemas/UtilizationAmount" } }, "title": "Line of Credit", "type": "object" } ], "title": "Line of Credit" }, "StatementDetails": { "oneOf": [ { "$ref": "#/components/schemas/InstallmentStatementDetails" }, { "$ref": "#/components/schemas/LOCStatementDetails" } ] }, "TransactionsPaging": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Transaction" }, "type": "array" } }, "type": "object" } ], "title": "transactions" }, "TransactionCreationStatus": { "description": "The transaction status. May only be passed when `isExternal=true`.\n\nExternal transactions can be created in: `scheduled`, `initiated`, `pending`, `succeeded`, or `failed`.\nExternal transactions are applied to the loan balance immediately when created with status `initiated`, `pending`, or `succeeded`. Otherwise,\nthey will be applied the first time they are updated to one of these statuses.\n\n`scheduled` - payment or credit was scheduled for a future date that has not arrived yet. The payment has not applied to a loan yet.\n\n`initiated` - payment was initiated and sent to a payment processor. The payment is applied to a loan. This status is used normally for ACH.\n\n`pending` - payment was acknowledged by the payment processor and is being processed. For ACH the payment can be in pending status for a few days.\n\n`succeeded` - payment was completed successfully.\n\n`failed` - payment failed and was removed from the loan effective as of `initiated`, `pending` or `succeeded` status effective date. The system replays the loan as if the payment never happened.\nIt will also re-accrue interest since then.\n\n`inDispute` - payment is in dispute (typically because of chargeback). The payment is removed from the loan effective as of `initiated`, `pending` or `succeeded` status effective date. The system replays the loan as if the payment never happened.\nIt will also re-accrue interest since then. Disputed payment can be for partial amount.\n\n`canceled` - payment or credit was canceled. Payment can be canceled only if the current status is `scheduled`.\n\n`chargeback` - payment was disputed and ruled against the lender. The payment was returned to the original payment instrument. Chargeback payment can be for partial amount.\n", "enum": [ "scheduled", "initiated", "pending", "succeeded", "failed", "canceled", "inDispute", "chargeback" ], "type": "string" }, "OneTimePaymentTransaction": { "allOf": [ { "$ref": "#/components/schemas/BaseOneTimePaymentTransaction" }, { "properties": { "consentDocumentId": { "allOf": [ { "$ref": "#/components/schemas/AnyId" }, { "description": "The document ID of a one-time payment consent given by the\nborrower to debit their payment instrument. The document is\nstored in the HTML format and contains the disclosure shown to\nthe borrower at the time of the payment. Required if\n`previewMode=false` and Peach is processing payments (aka\n`isExternal=false`) on behalf of the lender.\n" } ] }, "drawId": { "description": "The draw identifier. If provided, the system will attempt to apply the payment to the specified draw. Any excess will be applied to\nthe rest of LOC/Draws based on the multi-waterfall that is defined for the line of credit type.\n", "type": "string" }, "effectiveDate": { "description": "This attribute can be used only during the migration process of loans from another system to Peach. Any value passed for `active` loans will be ignored.\n\nThe effective date of the transaction in the product timezone. This attribute can be used for transactions with `isExternal=true` only.\nThe date must be in the past or today. Make sure to provide `effectiveTimeOfDay` also.\n", "format": "date", "type": "string" }, "effectiveTimeOfDay": { "allOf": [ { "$ref": "#/components/schemas/TimeOfDay" }, { "description": "The effective time of day on `effectiveDate` in the product timezone. This attribute can be used for transactions with `isExternal=true` only. Required if `effectiveDate` is passed.\n\nNote: for migration only, the value must be after 2AM in the product timezone.\n", "type": "object", "writeOnly": true } ] }, "enablePrepayments": { "description": "**DEPRECATED ATTRIBUTE**\n`true` if the borrower opts to apply any overpayment amount to prepayment of future obligations.\n`false` if the borrower opts to apply overpayments to the current obligation.\n\nIf this field is not passed, we reference the `allowPrepayments` configuration on the loan type.\n", "type": "boolean" }, "holdDaysEndDate": { "$ref": "#/components/schemas/HoldDaysEndDate" }, "isExternal": { "description": "A transaction marked `isExternal=true` is for record purposes only. A transaction with an external `paymentInstrument` is automatically marked external.", "type": "boolean" }, "scheduledDate": { "description": "This attribute should be used only for transactions that are scheduled in the future. Transactions that should be processed now/today,\nleave the attribute empty and the system will set appropriate date and timestamp values based on the API call time.\n\nNote: The maximum date you can set is the maximum of either three years after the last expected payment or three years from today.\n", "format": "date", "type": "string" }, "status": { "$ref": "#/components/schemas/TransactionCreationStatus" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ], "required": [ "paymentInstrumentId", "amount", "type" ], "title": "One Time Payment" }, "ServiceCreditTransaction": { "allOf": [ { "$ref": "#/components/schemas/BaseServiceCreditTransaction" }, { "properties": { "drawId": { "description": "The draw identifier. If provided, the system will attempt to apply the payment to the specified draw. Any excess will be applied to\nthe rest of LOC/Draws based on the multi-waterfall that is defined for the line of credit type.\n", "type": "string" }, "effectiveDate": { "description": "This attribute can be used only during the migration process of loans from another system to Peach.\nAny value passed for active loans will be ignored.\n\nThe effective date of the transaction in the product timezone.\nThis attribute can be used for transactions with `isExternal=true` only. The date must be in the past or today.\nMake sure to provide `effectiveTimeOfDay` also.\n", "format": "date", "type": "string", "writeOnly": true }, "effectiveTimeOfDay": { "allOf": [ { "$ref": "#/components/schemas/TimeOfDay" }, { "description": "The effective time of day on `effectiveDate` in the product timezone. This attribute can be used for transactions with `isExternal=true` only. Required if `effectiveDate` is passed.\n\nNote: for migration only, the value must be after 2AM in the product timezone.\n", "type": "object", "writeOnly": true } ] }, "enablePrepayments": { "description": "**DEPRECATED ATTRIBUTE**\n`true` if the borrower opts to apply any overpayment amount to prepayment of future obligations.\n`false` if the borrower opts to apply overpayments to the current obligation.\nIf this field is not passed, we reference the `allowPrepayments` configuration on the loan type.\n", "type": "boolean" }, "scheduledDate": { "description": "This attribute should be used only for transactions that need to be applied now/today or are scheduled in the future.\nTransactions that should be processed now/today, leave the attribute empty and the system\nwill set appropriate date and timestamp values based on the API call time.\nIf a future date is provided, the service credit will be scheduled for the future date and\nwon't be applied to the ledger until then.\n\nTo apply service credit with an effective date in the past, two steps are required:\n- Post service credit with an empty `scheduledDate.` The system will apply the service credit now/today.\n- Call \"Backdate transaction\" endpoint to move the service credit to a past date.\n\nNote: The maximum date you can set is the maximum of either three years after the last expected payment or three years from today.\n", "format": "date", "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ], "required": [ "serviceCreditType", "serviceCreditSponsor", "amount", "type" ], "title": "Service Credit" }, "serviceCreditTypesForCreate": { "enum": [ "serviceAgent", "serviceSupervisor", "settlementOfDebt", "balanceTransfer", "rewards", "fraud", "badDebt", "bankruptcy", "deceased", "usuryCap" ], "type": "string" }, "ServiceCreditTransactionForCreate": { "allOf": [ { "$ref": "#/components/schemas/ServiceCreditTransaction" }, { "properties": { "serviceCreditType": { "$ref": "#/components/schemas/serviceCreditTypesForCreate" } }, "type": "object" } ], "title": "Service Credit" }, "DownPaymentTransaction": { "allOf": [ { "$ref": "#/components/schemas/BaseDownPaymentTransaction" }, { "properties": { "consentDocumentId": { "allOf": [ { "$ref": "#/components/schemas/AnyId" }, { "description": "The document ID of a one-time payment consent given by the\nborrower to debit their payment instrument. The document is\nstored in the HTML format and contains the disclosure shown to\nthe borrower at the time of the payment. Required if\n`previewMode=false` and Peach is processing payments (aka\n`isExternal=false`) on behalf of the lender.\n" } ] }, "drawId": { "description": "The draw identifier. If provided, the system will attempt to apply the payment to the specified draw. Any excess will be applied to\nthe rest of LOC/Draws based on the multi-waterfall that is defined for the line of credit type.\n", "type": "string" }, "effectiveDate": { "description": "This attribute can be used only during the migration process of loans from another system to Peach. Any value passed for `active` loans will be ignored.\n\nThe effective date of the transaction in the product timezone. This attribute can be used for transactions with `isExternal=true` only.\nThe date must be in the past or today. Make sure to provide `effectiveTimeOfDay` also.\n", "format": "date", "type": "string" }, "effectiveTimeOfDay": { "allOf": [ { "$ref": "#/components/schemas/TimeOfDay" }, { "description": "The effective time of day on `effectiveDate` in the product timezone. This attribute can be used for transactions with `isExternal=true` only. Required if `effectiveDate` is passed.\n\nNote: for migration only, the value must be after 2AM in the product timezone.\n", "type": "object", "writeOnly": true } ] }, "isExternal": { "description": "A transaction marked `isExternal=true` is for record purposes only. A transaction with an external `paymentInstrument` is automatically marked external.", "type": "boolean" }, "scheduledDate": { "description": "If provided must be a date in the future.\n\nNote: The maximum date you can set is the maximum of either three years after the last expected payment or three years from today.\n", "format": "date", "type": "string" }, "status": { "$ref": "#/components/schemas/TransactionCreationStatus" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ], "required": [ "paymentInstrumentId", "amount", "type" ], "title": "Down Payment" }, "CreateTransaction": { "oneOf": [ { "$ref": "#/components/schemas/OneTimePaymentTransaction" }, { "$ref": "#/components/schemas/ServiceCreditTransactionForCreate" }, { "$ref": "#/components/schemas/DownPaymentTransaction" } ], "required": [ "type" ] }, "TransactionUpdate": { "allOf": [ { "$ref": "#/components/schemas/NormalTransaction" }, { "properties": { "currency": { "readOnly": true }, "isExternal": { "description": "**DEPRECATED ATTRIBUTE** Updating this field does not modify the transaction.\n\nA transaction marked `isExternal=true` is for record purposes only. A transaction with\nan external `paymentInstrument` is automatically marked external.\n" }, "isVirtual": { "description": "**DEPRECATED ATTRIBUTE** Updating this field does not modify the transaction.\n\nA transaction marked `isVirtual=true` is not a real transaction, but represents a part of another transaction.\nThis is used to store the principal/interest split on draws in Line of Credits as well as splits between multiple\ninstallment loans that were applied as a single payment.\n" }, "paidFeesAmount": { "description": "**DEPRECATED ATTRIBUTE** Support for this field will be removed in the future.\n\nThe paid amount allocated to fees\n" }, "paidInterestAmount": { "description": "**DEPRECATED ATTRIBUTE** Support for this field will be removed in the future.\n\nThe paid amount allocated to interest\n" }, "paidOverAmount": { "description": "**DEPRECATED ATTRIBUTE** Support for this field will be removed in the future.\n\nStores any excess amount that was not allocated to principal, interest or fees.\n" }, "paidPrincipalAmount": { "description": "**DEPRECATED ATTRIBUTE** Support for this field will be removed in the future.\n\nThe paid amount allocated to principal\n" }, "paymentDetails": { "readOnly": true }, "processorId": { "readOnly": true }, "serviceCreditDetails": { "readOnly": true }, "transactionType": { "readOnly": true } }, "type": "object" } ] }, "TransactionUpdateExternal": { "allOf": [ { "$ref": "#/components/schemas/TransactionUpdate" }, { "properties": { "timestamps": { "properties": { "effectiveDate": { "readOnly": true } }, "type": "object" } }, "type": "object" } ] }, "LoanUnfreeze": { "allOf": [ { "properties": { "previewMode": { "default": false, "description": "If `previewMode=true`, the loan doesn't change and no changes are saved to the database.\n", "type": "boolean" }, "retroactivelyAccrueInterest": { "default": false, "description": "`true` to accrue interest (as usual) for periods occurring when the loan was frozen. `false` to make\nperiodic payments occurring during the frozen period interest-free.\n", "type": "boolean" }, "sendNotice": { "default": true, "description": "When set to `false`, the system will NOT send a `loanUnfreeze` notice to the borrower.", "type": "boolean" }, "shiftDueDates": { "default": false, "description": "`true` to defer the periodic payment amounts associated with periods that fall in the frozen period to one or\nmore new periods generated at the end of a loan. `false` to keep the amounts in unfrozen periods.\n", "type": "boolean" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ] }, "fullAccountNumber": { "properties": { "accountNumber": { "description": "The full account number. Only provided if `showFullAccountNumber=true`.\nUser must have the `payment.instrument:read.sensitive` permission to get the full number.\n", "type": "string" } }, "type": "object" }, "PaymentCardImmutableFields": { "properties": { "cardNumberLastFour": { "description": "The last two, three or four digits of the card number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n", "example": "1111", "readOnly": true }, "cardType": { "description": "The type of card.\n\n- For external payment instruments, this field is required, and does not require additional permissions.\n\n- Otherwise, this field is not required, and using it requires permission `payment.instrument:force`.\n", "enum": [ "credit", "debit" ], "type": "string" }, "cvv": { "description": "The CVV, typically found on the back of the card.\nPeach does not save CVV and is only used to authenticate the card. Required if `isExternal=false`.\n", "example": "321", "type": "string", "writeOnly": true }, "instrumentType": { "enum": [ "card" ], "type": "string" }, "issuer": { "description": "Issuing bank. Requires permission `payment.instrument:force`.", "type": "string" }, "network": { "description": "Card network. Requires permission `payment.instrument:force`.", "enum": [ "visa", "mastercard", "discover", "americanExpress" ], "type": "string" } }, "type": "object" }, "PaymentCardMutableFields": { "properties": { "address": { "allOf": [ { "description": "The billing address associated with the card. If `isExternal=false`, then `postalCode` is required.\n" }, { "$ref": "#/components/schemas/AddressBase" } ] }, "expirationMonth": { "description": "The expiration month of the card.", "example": 12, "type": "integer" }, "expirationYear": { "description": "The expiration year of the card.", "example": 2032, "type": "integer" }, "firstName": { "description": "First name on the card.", "type": "string" }, "lastName": { "description": "Last name on the card.", "type": "string" } }, "type": "object" }, "PaymentCard": { "allOf": [ { "$ref": "#/components/schemas/PaymentInstrumentImmutableFields" }, { "$ref": "#/components/schemas/PaymentInstrumentFailureReasons" }, { "$ref": "#/components/schemas/PaymentInstrumentMutableFields" }, { "$ref": "#/components/schemas/PaymentCardImmutableFields" }, { "$ref": "#/components/schemas/PaymentCardMutableFields" } ], "required": [ "instrumentType", "cardNumber", "expirationYear", "expirationMonth", "firstName", "lastName" ], "title": "Card" }, "fullCardNumber": { "properties": { "cardNumber": { "description": "The full card number. Also called PAN. Only provided if `showFullAccountNumber=true`.\nUser must have the `payment.instrument:read.sensitive` permission to get the full number.\n", "type": "string" } }, "type": "object" }, "PaymentCheckMutable": { "allOf": [ { "$ref": "#/components/schemas/PaymentInstrumentMutableFields" }, { "properties": { "accountHolderName": { "description": "For `personal` accounts, the full name of the account holder. For `business` accounts, the business name.\n\nThis is not an account nickname. It should match the name on file for the account with the bank.\n", "type": "string" }, "accountHolderType": { "description": "Type of entity that is the account holder.", "enum": [ "business", "personal" ], "type": "string" }, "address": { "$ref": "#/components/schemas/AddressBase", "description": "The address on the check. Typically located in the top left corner, under the account holder name(s).\n" }, "payToTheOrderOfName": { "description": "The name of a person or organization designated to receive the funds,\nsuch as \"John Smith\" or \"Peach Finance, Inc\". Defaults to \"Cash\",\nused when you don't know the person or organization's exact name.\n", "type": "string" } }, "type": "object" } ], "title": "Check" }, "PaymentCheck": { "allOf": [ { "$ref": "#/components/schemas/PaymentInstrumentImmutableFields" }, { "$ref": "#/components/schemas/PaymentInstrumentFailureReasons" }, { "$ref": "#/components/schemas/PaymentInstrumentMutableFields" }, { "properties": { "accountNumberLastFour": { "description": "The last two, three or four digits of the account number.\nNormally, you should expect four digits. Two or three digits are returned when four digits are not available.\n", "pattern": "^[0-9]{2,4}", "readOnly": true, "type": "string" }, "checkNumber": { "description": "The check sequence number. Typically located in the top right corner of the check.", "type": "string" }, "institutionName": { "description": "The name of the bank where this account resides.", "readOnly": true, "type": "string" }, "instrumentType": { "enum": [ "check" ], "type": "string" }, "routingNumber": { "description": "The routing number.", "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/PaymentCheckMutable" } ], "required": [ "accountHolderName", "accountHolderType", "accountNumber", "checkNumber", "instrumentType", "routingNumber" ], "title": "Check" }, "Payroll": { "allOf": [ { "$ref": "#/components/schemas/PaymentInstrumentImmutableFields" }, { "$ref": "#/components/schemas/PaymentInstrumentMutableFields" }, { "properties": { "departmentName": { "description": "The department name.", "example": "Accounting", "type": "string" }, "employeeId": { "description": "The employee/borrower ID in the payroll system.", "type": "string" }, "employerName": { "description": "The employer name.", "type": "string" }, "instrumentType": { "enum": [ "payroll" ], "type": "string" }, "isExternal": { "enum": [ true ], "readOnly": true, "type": "boolean" }, "payFrequency": { "description": "The payment frequency.", "enum": [ "weekly", "everyTwoWeeks", "twiceMonthly", "monthly" ], "example": "everyTwoWeeks", "type": "string" }, "paySpecificDays": { "description": "The specific days on which paychecks are made. The allowed values for specific day(s) depends on the `payFrequency`.\n\n - `weekly` - provide one number in the valid range 1-7. 1=Monday...7=Sunday.\n For example: `[1]`.\n - `everyTwoWeeks` - provide one number in the valid range 1-14.\n First week: 1=Monday...7=Sunday.\n Second week: 8=Monday...14=Sunday.\n For example: `[1]`.\n - `twiceMonthly` - provide two numbers in the valid range 1-31. 1=first day of a month. Use `31` to indicate the last day of a month.\n For example: `[1, 15]` or `[15, 31]`.\n - `monthly` - provide one number in the valid range 1-31. 1=first day of a month. Use `31` to indicate the last day of a month.\n For example: `[1]`.\n", "example": [ 1, 15 ], "items": { "type": "integer" }, "type": "array" }, "paycheckNetAmount": { "description": "The amount of paycheck after taxes that is deposited to the borrower's bank account.", "example": 1024, "type": "number" } }, "type": "object" } ], "title": "Payroll" }, "PaymentNetwork": { "allOf": [ { "$ref": "#/components/schemas/PaymentInstrumentImmutableFields" }, { "$ref": "#/components/schemas/PaymentInstrumentMutableFields" }, { "properties": { "instrumentType": { "enum": [ "paymentNetwork" ], "type": "string" }, "isExternal": { "enum": [ true ], "readOnly": true, "type": "boolean" }, "paymentNetworkMemberId": { "description": "The borrower identifier in the payment network system.", "type": "string" }, "paymentNetworkName": { "description": "The payment network name.", "type": "string" } }, "type": "object" } ], "title": "Payment Network" }, "MoneyOrder": { "allOf": [ { "$ref": "#/components/schemas/PaymentInstrumentImmutableFields" }, { "$ref": "#/components/schemas/PaymentInstrumentMutableFields" }, { "properties": { "institutionName": { "description": "The name of the bank where this account resides.", "maxLength": 36, "type": "string" }, "instrumentType": { "enum": [ "moneyOrder" ], "type": "string" }, "isExternal": { "enum": [ true ], "readOnly": true, "type": "boolean" }, "routingNumber": { "description": "The routing number.", "pattern": "\\d{9}", "type": "string" }, "serialNumber": { "description": "The money order serial number.", "type": "string" } }, "type": "object" } ], "required": [ "instrumentType", "serialNumber" ], "title": "Money Order" }, "Wire": { "allOf": [ { "$ref": "#/components/schemas/PaymentInstrumentImmutableFields" }, { "$ref": "#/components/schemas/PaymentInstrumentMutableFields" }, { "properties": { "institutionName": { "description": "The name of the bank where this account resides.", "maxLength": 36, "type": "string" }, "instrumentType": { "enum": [ "wire" ], "type": "string" }, "isExternal": { "enum": [ true ], "readOnly": true, "type": "boolean" }, "routingNumber": { "description": "The routing number from where the wire was sent.", "pattern": "\\d{9}", "type": "string" }, "wireNumber": { "description": "The wire number. Must be unique.", "type": "string" }, "wireType": { "default": "domestic", "enum": [ "domestic", "international" ], "type": "string" } }, "type": "object" } ], "required": [ "instrumentType", "wireType", "wireNumber" ], "title": "Wire" }, "PaymentInstrumentGet": { "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/BankAccount" }, { "$ref": "#/components/schemas/fullAccountNumber" } ] }, { "allOf": [ { "$ref": "#/components/schemas/PaymentCard" }, { "$ref": "#/components/schemas/fullCardNumber" } ] }, { "allOf": [ { "$ref": "#/components/schemas/PaymentCheck" }, { "$ref": "#/components/schemas/fullAccountNumber" } ] }, { "allOf": [ { "required": [ "instrumentType", "employerName" ], "type": "object" }, { "$ref": "#/components/schemas/Payroll" } ], "title": "Payroll" }, { "allOf": [ { "required": [ "instrumentType", "paymentNetworkName" ], "type": "object" }, { "$ref": "#/components/schemas/PaymentNetwork" } ], "title": "Payment Network" }, { "allOf": [ { "$ref": "#/components/schemas/MoneyOrder" }, { "$ref": "#/components/schemas/fullAccountNumber" } ] }, { "allOf": [ { "$ref": "#/components/schemas/Wire" }, { "$ref": "#/components/schemas/fullAccountNumber" } ] } ] }, "hideFailureReason": { "properties": { "failureReason": { "readOnly": true } }, "type": "object" }, "SendNoticePaymentMethodAdded": { "properties": { "sendNotice": { "default": true, "description": "When set to `true`, the system will send a `paymentMethodAdded` notice to the borrower.\n", "type": "boolean" } }, "type": "object" }, "paymentCardCardNumber": { "properties": { "cardNumber": { "description": "The card number.\nIf `isExternal=true` then only the last two, three, or four digits of the card number can be provided.\nProvide four digits if available, otherwise provide two or three digits.\n", "example": "4111111111111111", "type": "string", "writeOnly": true } }, "required": [ "cardNumber" ], "type": "object" }, "paymentCheckAccountNumber": { "properties": { "accountNumber": { "description": "The account number.\nIf `isExternal=true` then the last two, three, or four digits of the account number can be provided.\nProvide four digits if available, otherwise provide two or three digits.\n", "pattern": "^[0-9]+$", "type": "string", "writeOnly": true } }, "required": [ "accountNumber" ], "type": "object" }, "PlaidToken": { "example": { "accessToken": "public-sandbox-deadbeef-dead-beef-dead-beefdeadbeef", "accountIds": [ "BnyjkeaawGiG7xgvV5noipAbVe6Edafwx3n97" ], "instrumentType": "plaid" }, "properties": { "accessToken": { "description": "`public_token` provided by Plaid Link.\n\n**NOTE**: Plaid Link tokens are associated with a specific Plaid API key. If you are performing a Plaid Link in your app/website\nand pass it to the Peach API you will first need to set your Plaid API key in the Peach API. Please contact Peach Support\nto get access to the Plaid API Key setting endpoint and instructions on how to use it.\n\nIf you wish to use your own Plaid Link token in the sandbox environment, please contact Peach Support as you might need\nto configure your Plaid sandbox account in a certain way.\n", "type": "string" }, "accountIds": { "description": "List of Plaid account IDs selected by user, provided by Plaid Link\n", "items": { "type": "string" }, "type": "array" }, "externalId": { "description": "A lender's identifier for the instrument.\n\nAfter the object is successfully created, a lender can use ID or externalId identifiers to fetch the object.\n\nTo fetch the object using externalId you need to add `ext-` to the URL.\n\nNote: Don't add ext- to the identifier value. For example: if the external identifier is `ABCDE`, then pass externalId=ACBCE and NOT ext-ABCDE when creating the object.\n", "minLength": 1, "nullable": true, "type": "string" }, "instrumentType": { "enum": [ "plaid" ], "type": "string" } }, "required": [ "accessToken", "accountIds" ], "title": "Plaid Link", "type": "object" }, "moneyOrderAccountNumber": { "properties": { "accountNumber": { "description": "The account number.\nIf `isExternal=true` then the last two, three, or four digits of the account number can be provided.\nProvide four digits if available, otherwise provide two or three digits.\n", "pattern": "^[0-9]+$", "type": "string", "writeOnly": true } }, "type": "object" }, "wireAccountNumber": { "properties": { "accountNumber": { "description": "The account number from where the wire was sent. Must consist of only digits.\nIf `isExternal=true` then the last two, three, or four digits of the account number can be provided.\nProvide four digits if available, otherwise provide two or three digits.\n", "pattern": "^[0-9]+$", "type": "string", "writeOnly": true } }, "type": "object" }, "PaymentInstrumentPost": { "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/BankAccount" }, { "$ref": "#/components/schemas/bankAccountAccountNumber" }, { "$ref": "#/components/schemas/hideFailureReason" }, { "$ref": "#/components/schemas/SendNoticePaymentMethodAdded" } ] }, { "allOf": [ { "$ref": "#/components/schemas/PaymentCard" }, { "$ref": "#/components/schemas/paymentCardCardNumber" }, { "$ref": "#/components/schemas/hideFailureReason" }, { "$ref": "#/components/schemas/SendNoticePaymentMethodAdded" } ] }, { "allOf": [ { "$ref": "#/components/schemas/PaymentCheck" }, { "$ref": "#/components/schemas/paymentCheckAccountNumber" }, { "$ref": "#/components/schemas/hideFailureReason" } ] }, { "allOf": [ { "required": [ "instrumentType", "employerName" ], "type": "object" }, { "$ref": "#/components/schemas/Payroll" }, { "$ref": "#/components/schemas/hideFailureReason" }, { "$ref": "#/components/schemas/SendNoticePaymentMethodAdded" } ], "title": "Payroll" }, { "allOf": [ { "required": [ "instrumentType", "paymentNetworkName" ], "type": "object" }, { "$ref": "#/components/schemas/PaymentNetwork" }, { "$ref": "#/components/schemas/hideFailureReason" }, { "$ref": "#/components/schemas/SendNoticePaymentMethodAdded" } ], "title": "Payment Network" }, { "allOf": [ { "$ref": "#/components/schemas/PlaidToken" }, { "$ref": "#/components/schemas/BankAccountMutableFields" }, { "$ref": "#/components/schemas/hideFailureReason" }, { "$ref": "#/components/schemas/SendNoticePaymentMethodAdded" }, { "properties": { "accountLink": { "readOnly": true }, "accountType": { "readOnly": true } }, "type": "object" } ], "title": "Plaid Account" }, { "allOf": [ { "$ref": "#/components/schemas/MoneyOrder" }, { "$ref": "#/components/schemas/moneyOrderAccountNumber" }, { "$ref": "#/components/schemas/hideFailureReason" } ] }, { "allOf": [ { "$ref": "#/components/schemas/Wire" }, { "$ref": "#/components/schemas/wireAccountNumber" }, { "$ref": "#/components/schemas/hideFailureReason" } ] } ] }, "PaymentInstrument": { "oneOf": [ { "$ref": "#/components/schemas/BankAccount" }, { "$ref": "#/components/schemas/PaymentCard" }, { "$ref": "#/components/schemas/PaymentCheck" }, { "allOf": [ { "required": [ "instrumentType", "employerName" ], "type": "object" }, { "$ref": "#/components/schemas/Payroll" } ], "title": "Payroll" }, { "allOf": [ { "required": [ "instrumentType", "paymentNetworkName" ], "type": "object" }, { "$ref": "#/components/schemas/PaymentNetwork" } ], "title": "Payment Network" }, { "$ref": "#/components/schemas/MoneyOrder" }, { "$ref": "#/components/schemas/Wire" } ] }, "SendNoticePaymentMethodUpdated": { "properties": { "sendNotice": { "default": true, "description": "When set to `true`, the system will send a `paymentMethodUpdated` notice to the borrower.\n", "type": "boolean" } }, "type": "object" }, "PaymentCardMutable": { "allOf": [ { "$ref": "#/components/schemas/PaymentInstrumentMutableFields" }, { "$ref": "#/components/schemas/PaymentCardMutableFields" } ], "title": "Card" }, "PaymentInstrumentMutable": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/BankAccountMutable" }, { "$ref": "#/components/schemas/SendNoticePaymentMethodUpdated" } ] }, { "allOf": [ { "$ref": "#/components/schemas/PaymentCardMutable" }, { "$ref": "#/components/schemas/SendNoticePaymentMethodUpdated" } ] }, { "$ref": "#/components/schemas/PaymentCheckMutable" }, { "allOf": [ { "$ref": "#/components/schemas/Payroll" }, { "$ref": "#/components/schemas/SendNoticePaymentMethodUpdated" } ] }, { "allOf": [ { "$ref": "#/components/schemas/PaymentNetwork" }, { "$ref": "#/components/schemas/SendNoticePaymentMethodUpdated" } ] } ] }, "AccountLinkUpdate": { "properties": { "dataServices": { "default": [ "accountInfo" ], "description": "A list of data services available with this link.", "items": { "enum": [ "accountInfo", "balance" ], "type": "string" }, "type": "array" }, "lastErrorCommunicationAt": { "description": "The date and time that the most recent error notification was sent to the user. When updated, `errorCommunicationsSent` is incremented.", "format": "date-time", "type": "string" } }, "type": "object" }, "AccountLinkBalanceEntry": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "availableBalanceAmount": { "description": "Indicates the balance that is available to spend net of any pending transactions. This balance should be used for insufficient funds (NSF) prevention use case.", "format": "float", "type": "number" }, "createdAt": { "description": "The date and time when this entry was fetched from the account link." }, "currency": { "description": "The currency used. Use ISO currency codes.", "type": "string" }, "currentBalanceAmount": { "description": "Indicates the current balance that does not take pending transactions into account.", "format": "float", "type": "number" }, "error": { "allOf": [ { "description": "If present, details of the error returned from the account link." }, { "$ref": "#/components/schemas/AccountLinkError" } ] }, "lastSuccessfulBalance": { "description": "The most recent balance data from a successful check. If the most recent balance check resulted in an error, this object is populated with last successfully fetched balances, if they exist.", "properties": { "availableBalanceAmount": { "description": "Indicates the balance that is available to spend net of any pending transactions. This balance should be used for insufficient funds (NSF) prevention use case.", "format": "float", "type": "number" }, "createdAt": { "description": "The date and time when this data was fetched from the account link.", "format": "date-time", "type": "string" }, "currency": { "description": "The currency used. Use ISO currency codes.", "type": "string" }, "currentBalanceAmount": { "description": "Indicates the current balance that does not take pending transactions into account.", "format": "float", "type": "number" } }, "type": "object" } }, "type": "object" } ] }, "VerificationAttempt": { "properties": { "createdAt": { "format": "date-time", "readOnly": true, "type": "string" }, "isSuccess": { "description": "`true` if this attempt to answer the questions was successful.\n", "readOnly": true, "type": "boolean" } }, "type": "object" }, "VerificationQuestionCategory": { "description": "The category of questions to include.\n\n- `inBorrowerPortal` indicates the answer to this question can\nbe found in the borrower portal.\n- `knownToBorrower` indicates the answer to this question\nis not found in borrower portal (and therefore must be known by the borrower).\n- `presetSecret` indicates the answer to this question was preconfigured by the borrower previously.\n", "enum": [ "inBorrowerPortal", "knownToBorrower", "presetSecret" ], "type": "string" }, "VerificationQuestion": { "properties": { "category": { "$ref": "#/components/schemas/VerificationQuestionCategory" }, "id": { "type": "string" }, "memo": { "description": "The text of the memo for the agent\n", "type": "string" }, "text": { "description": "The text of the question\n", "type": "string" } }, "type": "object" }, "VerificationStatus": { "description": "The status of the verification.\n\n- `pending` - Verification is pending and answers can still be provided.\n- `succeeded` - Verification was successfully completed.\n- `failed` - Verification failed—the maximum number of answer attempts was reached.\n- `insufficientKnowledge` - Verification could not be created because there is not enough information about the person to generate questions.\n- `expired` - Verification timed out and was expired.\n", "enum": [ "failed", "pending", "succeeded", "expired", "insufficientKnowledge" ], "readOnly": true, "type": "string" }, "Verification": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "description": "Object describes a borrower verification process. When a borrower initiates a phone call their\nidentity should be verified before they are allowed to make changes to their account.\n", "properties": { "agentUserId": { "description": "An identifier of the agent performing the verification\n", "readOnly": true, "type": "string" }, "attempts": { "description": "Represents the attempts to answer the questions associated with this borrower verification.\nThe responses are intentionally not included for privacy and security. There can only be a maximum\nof `maxAttempts`. There can only be one successful attempt. A successful attempt is one with\n`isSuccess` set to `true`.\n", "items": { "$ref": "#/components/schemas/VerificationAttempt" }, "readOnly": true, "type": "array" }, "expiresAt": { "format": "date-time", "readOnly": true, "type": "string" }, "maxAttempts": { "description": "The maximum number of times an attempt can be made to answer all the questions. If `maxAttempts`\nare made without success, then this verification's status is set to `failed`.\n", "readOnly": true, "type": "integer" }, "object": { "default": "verification", "enum": [ "verification" ], "readOnly": true, "type": "string" }, "personId": { "description": "An identifier of the borrower\n", "readOnly": true, "type": "string" }, "questions": { "description": "The questions that were generated and must be answered.\n", "items": { "$ref": "#/components/schemas/VerificationQuestion" }, "readOnly": true, "type": "array" }, "status": { "$ref": "#/components/schemas/VerificationStatus", "readOnly": true } }, "type": "object" } ], "title": "verification" }, "VerificationsPaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Verification" }, "type": "array" } }, "type": "object" } ] }, "VerificationPost": { "properties": { "verificationTypeId": { "description": "The ID of the borrower verification type to use when creating the verification.\nIf `null`, then use the default borrower verification type.\n", "type": "string" } }, "type": "object" }, "VerificationAttemptPost": { "properties": { "answers": { "description": "The list of answers to the questions for this verification. Ordering is not important, but the\n`questionId` must match the ID of the question to which the answer corresponds. *All* of the\nanswers must match the stored information about the borrower in order for the verification\nto be successful.\n", "items": { "properties": { "questionId": { "description": "The identifier for the question being answered.\n", "type": "string" }, "text": { "description": "The response text. This must match the stored information about the user.\nDifferent questions have different methods for matching the response text. For instance, some\nquestions will match in a case-insensitive manner, or expect a date-formatted string, or\nallow for a few misspelled characters (e.g., in a name).\n", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "Supercase": { "allOf": [ { "$ref": "#/components/schemas/BaseWithExternalIdMixin" }, { "properties": { "autoCreated": { "description": "True if the supercase was created by some automated method.\n", "type": "boolean" }, "companyId": { "description": "The company's ID", "readOnly": true, "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for creating the supercase.\nCan be an agent or automated system process.\n" }, "description": { "description": "A description of the supercase and/or the precipitating event\nof the supercase.\n", "nullable": true, "type": "string" }, "eventStartedAt": { "description": "The date and time at which the precipitating event took place. For instance, in the\ncase of a bug, the earliest date at which the bug affected customers; in the case\nof a disaster, the date at which the disaster occurred.\n", "format": "date-time", "nullable": true, "type": "string" }, "femaDisasterDetails": { "description": "The details of the associated FEMA disaster.", "nullable": true, "properties": { "beginDate": { "description": "Date the incident itself began.", "format": "date", "nullable": true, "type": "string" }, "declarationDate": { "description": "Date the disaster was declared.\n", "format": "date", "type": "string" }, "description": { "type": "string" }, "endDate": { "description": "Date the incident itself ended.", "format": "date", "nullable": true, "type": "string" }, "hmProgramDeclared": { "description": "Denotes whether the Hazard Mitigation program was declared for this\ndisaster. For more information on the program,\nplease visit: www.fema.gov.\n", "type": "boolean" }, "iaProgramDeclared": { "description": "Denotes whether the Individual Assistance program was declared\nfor this disaster. For more information on the program,\nplease visit: www.fema.gov.\n", "type": "boolean" }, "ihProgramDeclared": { "description": "Denotes whether the Individuals and Households program was declared\nfor this disaster. For more information on the program,\nplease visit: www.fema.gov.\n", "type": "boolean" }, "impactedAreas": { "items": { "properties": { "countyArea": { "type": "string" }, "placeCode": { "type": "string" }, "state": { "type": "string" } }, "type": "object" }, "type": "array" }, "incidentType": { "description": "Type of incident such as fire or flood. The incident type will\naffect the types of assistance available. For more information on\nincident types, please visit: www.fema.gov.\n", "maxLength": 100, "type": "string" }, "lastRefreshAt": { "description": "Date the record was last updated in the FEMA API data store.", "format": "date-time", "nullable": true, "type": "string" }, "paProgramDeclared": { "description": "Denotes whether the Public Assistance program was declared for this\ndisaster. For more information on the program,\nplease visit: www.fema.gov.\n", "type": "boolean" } }, "readOnly": true, "type": "object" }, "femaDisasterNumber": { "description": "The associated FEMA disaster number.\n", "type": "integer" }, "femaMonitoringEndDate": { "description": "If set, the FEMA supercase monitoring will stop after this date.\n", "format": "date", "nullable": true, "type": "string" }, "name": { "description": "Name of the supercase.", "maxLength": 128, "type": "string" }, "object": { "default": "supercase", "enum": [ "supercase" ], "readOnly": true, "type": "string" }, "outcome": { "$ref": "#/components/schemas/ProcessOutcome" }, "status": { "$ref": "#/components/schemas/ProcessStatus" }, "statusUpdatedAt": { "description": "The date and time at which the status was last updated on this supercase.", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "subcaseName": { "description": "The name of the subcase which will be used when creating new subcases for this supercase.\n", "nullable": true, "type": "string" }, "subcaseTypeId": { "description": "The ID of the case-type which will be used when creating new subcases for this supercase.\nWhen a population is committed (by settings its `isDraft: false`) subcases of this type\nare created for all members of the population.\n\nNotes:\n- This is different from the `supercaseType`\n- This must be NOT null in order to commit a population.\n", "nullable": true, "type": "string" }, "supercaseType": { "$ref": "#/components/schemas/SupercaseType" } }, "type": "object" } ], "description": "A supercase allows for the management of many subcases. It is useful, for\ninstance, when there is an issue which effects a large group of borrowers.\n" }, "SupercaseCollection": { "items": { "$ref": "#/components/schemas/Supercase" }, "type": "array" }, "BulkSendRequestBody": { "properties": { "attachments": { "description": "An optional list of documents to attach to the outgoing email.\n", "items": { "description": "A document descriptor ID.", "type": "string" }, "type": "array" }, "channel": { "$ref": "#/components/schemas/InteractionChannel" }, "context": { "type": "object" }, "isTransactional": { "type": "boolean" }, "subject": { "$ref": "#/components/schemas/InteractionSubject" }, "theme": { "$ref": "#/components/schemas/InteractionTheme" } }, "required": [ "subject" ], "type": "object" }, "SupercaseBulkOperation": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "casesFailed": { "description": "The number of cases on which the operation failed.", "type": "integer" }, "casesIneligible": { "description": "The number of cases on which the operation could not succeed due\nto external factors. For example, if your operation requires the\nsubcase to be open to have any meaningful effect, then a closed\nsubcase would be considered ineligible.\n", "type": "integer" }, "casesProcessed": { "description": "The total number of processed and/or ineligible subcases.", "type": "integer" }, "completed": { "description": "Set to `true` if operation is completed.", "type": "boolean" }, "createdBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for creating the supercase.\nCan be an agent or automated system process.\n" }, "errorLog": { "description": "List of error reports for each failed subcase level operations.", "items": { "type": "object" }, "type": "array" }, "finishedAt": { "description": "The time operation finished.", "format": "date-time", "type": "string" }, "object": { "default": "SupercaseBulkOperation", "enum": [ "SupercaseBulkOperation" ], "readOnly": true, "type": "string" }, "startedAt": { "description": "The time operation started.", "format": "date-time", "type": "string" }, "supercaseId": { "readOnly": true, "type": "string" } }, "type": "object" }, { "anyOf": [ { "properties": { "firstInteraction": { "nullable": true, "type": "object" }, "noteId": { "nullable": true, "type": "string" }, "operationType": { "description": "The different types of bulk operations.", "enum": [ "update" ], "readOnly": true, "type": "string" }, "requestBody": { "$ref": "#/components/schemas/CasePut", "description": "The body of the bulk operation request", "readOnly": true } }, "title": "update", "type": "object" }, { "properties": { "firstInteraction": { "$ref": "#/components/schemas/Interaction" }, "noteId": { "nullable": true, "type": "string" }, "operationType": { "description": "The different types of bulk operations.", "enum": [ "sendMessage" ], "readOnly": true, "type": "string" }, "requestBody": { "$ref": "#/components/schemas/BulkSendRequestBody", "description": "The body of the bulk operation request", "readOnly": true } }, "title": "sendMessage", "type": "object" }, { "properties": { "firstInteraction": { "nullable": true, "type": "object" }, "noteId": { "nullable": true, "type": "string" }, "operationType": { "description": "The different types of bulk operations.", "enum": [ "createDoNotInteract" ], "readOnly": true, "type": "string" }, "requestBody": { "$ref": "#/components/schemas/DoNotInteract", "description": "The body of the bulk operation request", "readOnly": true } }, "title": "createDoNotInteract", "type": "object" }, { "properties": { "firstInteraction": { "nullable": true, "type": "object" }, "noteId": { "nullable": true, "type": "string" }, "operationType": { "description": "The different types of bulk operations.", "enum": [ "deleteDoNotInteract" ], "readOnly": true, "type": "string" }, "requestBody": { "nullable": true, "readOnly": true, "type": "object" } }, "title": "deleteDoNotInteract", "type": "object" }, { "properties": { "firstInteraction": { "nullable": true, "type": "object" }, "noteId": { "nullable": false, "type": "string" }, "operationType": { "description": "The different types of bulk operations.", "enum": [ "sendInstructionsByTask" ], "readOnly": true, "type": "string" }, "requestBody": { "$ref": "#/components/schemas/NoteRequest", "description": "The body of the bulk operation request", "readOnly": true } }, "title": "sendInstructionsByTask", "type": "object" } ] } ] }, "MemberBulkOperationResult": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "borrowerId": { "description": "The ID of the borrower associated with this member", "readOnly": true, "type": "string" }, "caseId": { "description": "The ID of the subcase associated with this member", "readOnly": true, "type": "string" }, "populationMembershipId": { "description": "The ID of the population membership", "readOnly": true, "type": "string" }, "status": { "description": "The status of the bulk operation", "enum": [ "success", "failed", "notProcessed" ], "readOnly": true, "type": "string" }, "supercaseBulkOperationId": { "description": "Supercase bulk operation ID", "readOnly": true, "type": "string" } }, "type": "object" } ], "description": "A member bulk operation result represents the result of a bulk operation\non a single member of a supercase population.\n" }, "TargetPopulation": { "allOf": [ { "$ref": "#/components/schemas/BaseWithExternalIdMixin" }, { "properties": { "populationId": { "description": "The ID of the population", "readOnly": true, "type": "string" }, "supercaseBulkOperationId": { "description": "Supercase bulk operation ID", "readOnly": true, "type": "string" } }, "type": "object" } ], "description": "A target population represents a committed population that will be affected\nby the supercase bulk operation. Each supercase bulk operation would\nprocess one or more target populations.\n" }, "Population": { "allOf": [ { "$ref": "#/components/schemas/BaseWithExternalIdMixin" }, { "properties": { "companyId": { "description": "The unique company identifier.", "readOnly": true, "type": "string" }, "isDraft": { "description": "`True` if this is the draft population of the supercase.\n", "readOnly": true, "type": "boolean" }, "object": { "default": "population", "enum": [ "population" ], "readOnly": true, "type": "string" }, "supercaseId": { "description": "Identifier of the supercase that the population belongs to.", "readOnly": true, "type": "string" } }, "type": "object" } ], "description": "A supercase may affect many borrower-loans. A supercase population represents one instance\nof adding borrower-loans to a supercase. It's important to keep track of which borrower-loans\nwere added at which time, because different actions may need to be taken depending on\nwhen a borrower-loan is added to a supercase.\n" }, "PopulationCollection": { "items": { "$ref": "#/components/schemas/Population" }, "type": "array" }, "PopulationMember": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "borrowerId": { "description": "The borrower ID of a borrower affected by this supercase.\n\nYou must specify a borrower in addition to a loan because a loan might have multiple borrowers\nand only one of them might be affected by this supercase.\n", "type": "string" }, "caseId": { "description": "The ID of the subcase with which this borrower-loan is associated", "readOnly": true, "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserActionInfo", "description": "Details of the user responsible for creating the member.\nCan be an agent or automated system process.\n" }, "loanId": { "description": "The loan ID of a loan affected by this supercase. The loan must be associated with the\nspecified borrower.\n", "nullable": true, "type": "string" } }, "type": "object" } ] }, "PopulationMemberCollection": { "items": { "$ref": "#/components/schemas/PopulationMember" }, "type": "array" }, "User": { "allOf": [ { "$ref": "#/components/schemas/UserBasic" }, { "properties": { "employee": { "allOf": [ { "$ref": "#/components/schemas/Employee" }, { "readOnly": true } ] }, "person": { "allOf": [ { "$ref": "#/components/schemas/Borrower", "nullable": true }, { "readOnly": true } ] } }, "type": "object" } ] }, "UsersPaging": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/User" }, "type": "array" } }, "type": "object" } ] }, "UserUpdate": { "allOf": [ { "$ref": "#/components/schemas/UserBase" }, { "properties": { "associatedPersonId": { "description": "**DEPRECATED ATTRIBUTE** Use `borrowerId`.\n\nThe ID of the borrower to be associated with this user.\nOnly applicable when `userType` is set to `borrower`.\n", "nullable": true, "type": "string" }, "borrowerId": { "description": "The ID of the borrower to be associated with this user.\nOnly applicable when `userType` is set to `borrower`.\n", "nullable": true, "type": "string" }, "roles": { "description": "**DEPRECATED ATTRIBUTE** Use `roleIds`.\n\nList of role IDs to associate with this user upon creation.\n", "items": { "type": "string" }, "nullable": true, "type": "array" }, "userType": { "description": "**DEPRECATED ATTRIBUTE** Use `type`.\n", "enum": [ "borrower", "agent", "service" ], "type": "string" } }, "type": "object" } ] }, "UserCreate": { "allOf": [ { "$ref": "#/components/schemas/UserUpdate" }, { "properties": { "authType": { "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "phone": { "type": "string" }, "samlSubjectNameId": { "type": "string" } }, "type": "object" } }, "type": "object" } ] }, "NewPassword": { "properties": { "password": { "description": "The new password to use. Only applicable for `basic` auth.\n", "nullable": true, "type": "string" } }, "type": "object" }, "NewEmailAuth": { "allOf": [ { "properties": { "email": { "description": "The email address to use for the new auth.\n", "type": "string" } }, "required": [ "email" ], "type": "object" }, { "$ref": "#/components/schemas/NewPassword" } ] }, "NewPhoneAuth": { "allOf": [ { "properties": { "phone": { "description": "The phone number to use for the new auth.\n", "type": "string" } }, "required": [ "phone" ], "type": "object" }, { "$ref": "#/components/schemas/NewPassword" } ] }, "NewSAMLAuth": { "allOf": [ { "properties": { "samlSubjectNameId": { "description": "The SAML subject name ID to use for the new auth.\n", "type": "string" } }, "required": [ "samlSubjectNameId" ], "type": "object" }, { "$ref": "#/components/schemas/NewPassword" } ] }, "NewAuth": { "oneOf": [ { "$ref": "#/components/schemas/NewEmailAuth" }, { "$ref": "#/components/schemas/NewPhoneAuth" }, { "$ref": "#/components/schemas/NewSAMLAuth" } ] }, "Permission": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "description": "A permission is assigned to a role, which allows designated users within a company to perform an action\n", "properties": { "action": { "description": "The name of the handler function that is allowed", "type": "string" }, "companyId": { "description": "Unique ID for the company that owns the permission", "type": "string" } }, "title": "permission", "type": "object" } ] }, "Role": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "description": "A role is a collection of permitted actions that can be performed by a user within the context of a single\ncompany.\n", "properties": { "alias": { "description": "An optional Human-readable instance name", "maxLength": 100, "minLength": 0, "nullable": true, "type": "string" }, "companyId": { "description": "Company that the role is associated with", "readOnly": true, "type": "string" }, "isSuperAdmin": { "description": "Whether this role has super-admin status. Only super-admin roles can hold super-admin permissions.\nSuper-admin roles are reserved for Peach.\n", "readOnly": true, "type": "boolean" }, "permissions": { "description": "Array of Permission objects associated with the role", "items": { "$ref": "#/components/schemas/Permission" }, "nullable": true, "readOnly": true, "type": "array" } }, "type": "object" } ] }, "RoleCollection": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Role" }, "type": "array" } }, "type": "object" } ] }, "VerificationQuestionsPaging": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/VerificationQuestion" }, "type": "array" } }, "type": "object" } ] }, "VerificationType": { "description": "The object describing how to perform borrower verifications\n", "properties": { "enabledQuestionIds": { "description": "List of question IDs the system will consider when randomly selecting questions\nfor verification; if `null` then all available questions will be considered.\n(See all available questions).\n", "items": { "type": "string" }, "nullable": true, "type": "array" }, "expirationInSecs": { "default": 900, "description": "How many seconds each verification session has until it is marked as expired.\n", "type": "integer" }, "id": { "readOnly": true, "type": "string" }, "maxAttemptsPerSession": { "default": 3, "description": "The number of attempts to answer the verification questions a borrower is allowed.\n", "type": "integer" }, "maxSessionsRecentPast": { "default": 2, "description": "Throttles maximum verification sessions a borrower can initiate within\n\"the recent past\". Where recent past time length is configured via `recentPastSecs`.\n", "type": "integer" }, "questionSelectionCriteria": { "description": "Object describing which and how many questions (at a minimum) to select at random.\n(Only questions with IDs present in `enabledQuestionIds` will be considered.)\n", "items": { "properties": { "category": { "$ref": "#/components/schemas/VerificationQuestionCategory" }, "exactMatchCount": { "description": "The number of questions matching this type to include.\n", "type": "integer" } }, "type": "object" }, "type": "array" }, "recentPastSecs": { "default": 3600, "description": "The number of seconds into the past which is considered the \"recent past\"\nfor the purposes of throttling verifications. See: `maxSessionsRecentPast`.\n", "type": "integer" } }, "type": "object" }, "VerificationTypesPaging": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/VerificationType" }, "type": "array" } }, "type": "object" } ] }, "eventTypesPublic": { "enum": [ "autopay.schedule.cancel", "autopay.schedule.created", "autopay.payment.rescheduled", "autopay.payment.canceled", "card.created", "card.replacement.requested", "card.status.changed", "case.association.added", "case.association.removed", "case.donotinteract.created", "case.donotinteract.deleted", "case.donotinteract.updated", "case.donotinteract.changed", "case.donotinteract.expired", "case.escalation.changed", "case.created", "case.updated", "case.deleted", "case.changed", "communication.send", "indexrate.created", "indexrate.updated", "loan.closed", "loan.created", "loan.current", "loan.fee.capitalized", "loan.credit.limit.changed", "draw.credit.limit.changed", "draw.fee.booked", "loan.balance.changed", "loan.foreigntransactionfee.booked", "loan.overdue", "loan.overdue.update", "loan.interestaccrued.min", "loan.interest.capitalized", "loan.statuschanged", "loan.latefee.booked", "loan.migration.succeeded", "loan.migration.failed", "loan.modificationfee.booked", "loan.nsffee.booked", "loan.fee.booked", "loan.fee.canceled", "loan.fee.changed", "loan.label.added", "loan.label.removed", "loan.remainingbalances.deferred", "loan.promoprogram.activated", "loan.promoprogram.canceled", "loan.promoprogram.created", "loan.promoprogram.exercised", "loan.promoprogram.reactivated", "loan.promoprogram.updated", "loan.paymentplan.setup", "loan.promiseplan.created", "loan.promiseplan.statuschanged", "loan.promiseplan.due.today", "loan.promiseplan.overdue", "loan.promiseplan.current", "loan.purchasefee.booked", "loan.duedate.defer", "loan.schedule.defer", "loan.ownerchanged", "loan.rate.created", "loan.rate.updated", "loan.refunded", "loan.reimbursement.initiated", "loan.reimbursement.processed", "loan.period.started", "loan.obligation.statuschanged", "loan.servicefee.booked", "loan.membershipfee.booked", "statement.created", "paymentplan.created", "paymentplan.statuschanged", "person.created", "person.consent.updated", "person.monitoring.scra.started", "person.monitoring.bankruptcy.started", "contact.created", "contact.deleted", "contact.updated", "payment.instrument.created", "payment.instrument.updated", "payment.instrument.deactivated", "interaction.blocked", "payment.applied", "payment.chargeback", "payment.chargeback.reversed", "payment.failed", "payment.initiated", "payment.pending", "payment.succeeded", "payment.reversed", "payment.scheduled", "payment.rescheduled", "payment.due.today", "payment.hold.days.expired", "purchase.authorized", "purchase.settled", "purchase.applied", "purchase.changed", "purchase.created", "purchase.dispute.created", "purchase.dispute.updated", "loan.creditreporting.created", "loan.creditreporting.stopped", "ach.file.created", "ach.file.upload.attempted", "ach.file.upload.failed", "ach.file.upload.succeeded", "reconciliation.payment.failed", "supercase.changed" ] }, "WebhookDirectDetails": { "description": "The details required for Peach to pass the events via webhook. Required only if `webhookType=direct`.\n", "properties": { "webhookUrl": { "description": "The URL that Peach will hit when an applicable event fires.\n", "type": "string" } }, "type": "object" }, "WebhookProxyDetails": { "description": "The details required for Peach to make an API call to the third party identified in the `webhookType`.\nRequired only if `webhookType=proxyXXX`.\n", "properties": { "galileoApiLogin": { "description": "The Galileo API login needed to make API calls via Peach's proxy.\n", "type": "string", "writeOnly": true }, "galileoApiTransKey": { "description": "The Galileo API key needed to make API calls via Peach's proxy.\n", "type": "string", "writeOnly": true }, "galileoBaseUrl": { "description": "The Galileo base URL.", "type": "string" }, "galileoProviderId": { "description": "The Galileo provider ID.", "type": "string" } }, "type": "object" }, "WebhookSubscriptionPut": { "allOf": [ { "$ref": "#/components/schemas/BaseMixin" }, { "properties": { "companyId": { "description": "The unique company identifier.\n", "readOnly": true, "type": "string" }, "enabled": { "default": true, "description": "If `true` events will be sent to this webhook, if `false` no events will be sent to it.", "type": "boolean" }, "hmacSecretKey": { "description": "This automatically generated key will be used to compute the message signature of each request from Peach to\nauthenticate the message and validate the message's integrity. Peach uses SHA-256 to generate the message signature,\nwhich will be passed in the request via a header called `X-PEACH-HMAC`.\n", "readOnly": true, "type": "string" }, "hydrateData": { "default": false, "description": "Indicates the amount of information the receiver of webhooks will get. Only applicable if `webhookType=direct`.\n- `false` - Peach will provide a minimum amount of data. For example: event identifier, event name, timestamp and\n identifier(s) of associated object(s) (e.g. loan ID, borrower ID, transaction ID, etc.)\n- `true` - in addition to the data provided in the `false` option, Peach will provide full details of the object(s)\n associated with the event.\n\nCurrently we support hydrating the following objects:\n - `borrower`\n - `loan`\n - `transaction`\n - `case`\n", "type": "boolean" }, "webhookDirectDetails": { "$ref": "#/components/schemas/WebhookDirectDetails" }, "webhookProxyDetails": { "$ref": "#/components/schemas/WebhookProxyDetails" } }, "type": "object" } ] }, "WebhookSubscription": { "allOf": [ { "properties": { "eventTypes": { "description": "The list of events for which the caller will receive webhooks.\nFor any proxy `webhookType`, this field should be left empty, and we will automatically send the events\nassociated with that specific proxy.\n", "items": { "allOf": [ { "$ref": "#/components/schemas/eventTypesPublic" }, { "type": "string" } ] }, "type": "array" }, "webhookType": { "description": "Peach supports two ways of receiving webhooks:\n- `direct` - events will be provided directly to the url nominated by the lender, and the event data will match Peach's data format.\n- `proxyGalileo` - events will trigger Peach to make specific API calls to Galileo, so Galileo's sub-ledger remains in sync with Peach's ledger.\n\nNote: when setting webhookType as `proxyGalileo`, please work with the Peach team to ensure the API calls you require are configured.\n", "enum": [ "direct", "proxyGalileo" ], "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/WebhookSubscriptionPut" } ] }, "Error": { "properties": { "data": { "description": "Additional data about the error.", "nullable": true, "type": "object" }, "detail": { "description": "**Deprecated**. Use `message` instead. Same contents as `message`.\n", "nullable": true, "type": "string" }, "errorType": { "description": "Error code.", "type": "string" }, "message": { "description": "Description of the server action or error.", "type": "string" }, "status": { "description": "HTTP status code.", "type": "integer" } }, "type": "object" }, "InvalidInput": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "properties": { "errorType": { "description": "Error code.", "enum": [ "InvalidInput" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 400 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "BadRequest": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "properties": { "errorType": { "description": "Error code.", "enum": [ "BadRequest" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 400 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "InvalidJSON": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The request body is not valid JSON.", "properties": { "errorType": { "description": "Error code.", "enum": [ "InvalidJSON" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 400 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "InvalidSpecificDays": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The provided specific statement and/or due dates are invalid.\n", "properties": { "errorType": { "description": "Error code.", "enum": [ "InvalidSpecificDays" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 400 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "InvalidPublicId": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "properties": { "errorType": { "description": "Error code.", "enum": [ "InvalidPublicId" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 422 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "UnprocessableEntity": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "properties": { "errorType": { "description": "Error code.", "enum": [ "UnprocessableEntity" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 422 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "Unauthorized": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The user is not authenticated.", "properties": { "errorType": { "description": "Error code.", "enum": [ "Unauthorized" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 401 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "Forbidden": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The user is not authorized to perform the action.", "properties": { "errorType": { "description": "Error code.", "enum": [ "Forbidden" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 403 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "NotFound": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "properties": { "errorType": { "description": "Error code.", "enum": [ "NotFound" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 404 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "UrlNotDefined": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The requested URL is not defined.", "properties": { "errorType": { "description": "Error code.", "enum": [ "UrlNotDefined" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 404 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "TemplateDisabled": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "properties": { "errorType": { "description": "Error code.", "enum": [ "TemplateDisabled" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 409 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "NoSuitableContact": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "No borrower contact matching the given criteria was found.", "properties": { "errorType": { "description": "Error code.", "enum": [ "NoSuitableContact" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 409 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "UndefinedTemplateVariable": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The template variable could not render due to a missing variable.", "properties": { "errorType": { "description": "Error code.", "enum": [ "UndefinedTemplateVariable" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 400 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "BadExternalServiceCredentials": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The credentials provided for an external service are invalid.", "properties": { "errorType": { "description": "Error code.", "enum": [ "BadExternalServiceCredentials" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 400 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "TemplateSyntax": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "properties": { "errorType": { "description": "Error code.", "enum": [ "TemplateSyntax" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 409 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "Duplicate": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The resource already exists.", "properties": { "errorType": { "description": "Error code.", "enum": [ "Duplicate" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 409 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "ConfigMismatch": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The requested operation is not compatible with the current configuration.", "properties": { "errorType": { "description": "Error code.", "enum": [ "ConfigMismatch" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 409 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "CompanyConfigMismatch": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The company is configured in a way that is incompatible with the requested operation", "properties": { "errorType": { "description": "Error code.", "enum": [ "CompanyConfigMismatch" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 409 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "LoanLocked": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The loan is currently locked for processing.", "properties": { "errorType": { "description": "Error code.", "enum": [ "LoanLocked" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 423 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "CardLocked": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "Purchase processing still running for this card.", "properties": { "errorType": { "description": "Error code.", "enum": [ "CardLocked" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 409 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "InternalServerError": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "An unexpected error occurred.", "properties": { "errorId": { "description": "Unique error identifier to share with support.", "format": "uuid", "type": "string" }, "errorType": { "description": "Error code.", "enum": [ "InternalServerError" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 500 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "ReadReplicaNotReady": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "The read replica is not ready.", "properties": { "errorType": { "description": "Error code.", "enum": [ "ReadReplicaNotReady" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 412 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "Timeout": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "A timeout occurred while processing the request.", "properties": { "errorType": { "description": "Error code.", "enum": [ "Timeout" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 504 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "MinPaymentConfiguration": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "An invalid min payment configuration was supplied.", "properties": { "errorType": { "description": "Error code.", "enum": [ "MinPaymentConfiguration" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 400 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "MigratedLoanReverseAccelerationOrChargeOff": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "Cannot reverse accelerate or charge off a migrated loan that was accelerated/charged off before migration cutoff date.", "properties": { "errorType": { "description": "Error code.", "enum": [ "MigratedLoanReverseAccelerationOrChargeOff" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 400 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "RulesCodeSyntaxError": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "Rules code contains a syntax error and cannot be processed.\n", "properties": { "errorType": { "description": "Error code.", "enum": [ "RulesCodeSyntaxError" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 400 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] }, "InactiveCompany": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "description": "Communications are blocked because the company is inactive.", "properties": { "errorType": { "description": "Error code.", "enum": [ "InactiveCompany" ], "type": "string" }, "status": { "description": "HTTP status code.", "enum": [ 409 ], "type": "integer" } }, "type": "object" } ], "x-tags": [ "Errors" ] } }, "securitySchemes": { "apiKeyHeader": { "in": "header", "name": "X-API-KEY", "type": "apiKey", "x-apikeyInfoFunc": "peach.security.handlers.api_key_auth", "x-scopeValidateFunc": "peach.security.handlers.scope_validate" }, "bearerAuth": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http", "x-bearerInfoFunc": "peach.security.handlers.bearer_auth", "x-scopeValidateFunc": "peach.security.handlers.scope_validate" }, "bearerAuthQuery": { "in": "query", "name": "token", "type": "apiKey", "x-apikeyInfoFunc": "peach.security.handlers.bearer_auth", "x-scopeValidateFunc": "peach.security.handlers.scope_validate" }, "oauth2": { "flows": {}, "type": "oauth2", "x-scopeValidateFunc": "peach.security.handlers.scope_validate", "x-tokenInfoFunc": "peach.security.handlers.oauth2" } }, "parameters": { "companyId": { "description": "The unique company identifier.", "in": "path", "name": "companyId", "required": true, "schema": { "type": "string" } }, "sortBy": { "description": "The data attributes by which to sort the results.", "in": "query", "name": "sortBy", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, "limit": { "description": "The maximum count of results to retrieve.", "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } }, "startingAfter": { "description": "Return results starting after the provided object identifier.", "in": "query", "name": "startingAfter", "schema": { "type": "string" } }, "endingBefore": { "description": "Return results ending before the provided object identifier.", "in": "query", "name": "endingBefore", "schema": { "type": "string" } }, "offset": { "description": "Offset from the start of results.", "in": "query", "name": "offset", "required": false, "schema": { "minimum": 0, "type": "integer" } }, "companyIdQuery": { "description": "The unique company identifier.", "in": "query", "name": "companyId", "schema": { "minimum": 1, "type": "string" } }, "domainQuery": { "description": "A valid domain associated with a company", "in": "query", "name": "domain", "schema": { "type": "string" } }, "userTypeQuery": { "description": "User type.", "in": "query", "name": "userType", "schema": { "type": "string" } }, "authTypeQuery": { "description": "The authentication type to explicitly use\n", "in": "query", "name": "authType", "schema": { "$ref": "#/components/schemas/AuthType" } }, "authValueTypeQuery": { "description": "The authentication value type to explicitly use\n", "in": "query", "name": "authValueType", "schema": { "$ref": "#/components/schemas/AuthValueType" } }, "appDomainTypeQuery": { "description": "App Domain Type.", "in": "query", "name": "appDomainType", "schema": { "$ref": "#/components/schemas/AppDomainType" } }, "bulkSenderId": { "in": "path", "name": "bulkSenderId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "contactExporterId": { "description": "The contactExporter object unique identifier.", "in": "path", "name": "contactExporterId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "borrowerCampaignId": { "in": "path", "name": "borrowerCampaignId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "borrowerCampaignRunId": { "in": "path", "name": "borrowerCampaignRunId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "downloadFile": { "description": "Specify which file should be downloaded from this campaign run. The requested files will be returned as a `.zip` file.\n\n- `query_results.csv` - A CSV formatted file of the query results received from Redash\n- `campaign_input.json` - A JSON formatted file of the parsed query results used as input to the campaign\n- `contacts.csv` - The exported contacts as CSV—i.e., the output.\n- `log.txt` - A log of the campaign run process.\n", "in": "query", "name": "file", "schema": { "default": "all", "enum": [ "all", "query_results.csv", "campaign_input.json", "contacts.csv", "log.txt" ], "type": "string" } }, "cardIssuerId": { "description": "The ID of the card issuer", "in": "path", "name": "cardIssuerId", "required": true, "schema": { "type": "string" } }, "loanTypeIdFilter": { "description": "Use this to limit results to a specific lender product.", "in": "query", "name": "loanTypeId", "schema": { "items": { "$ref": "#/components/schemas/AnyId" }, "type": "array" } }, "smartReviewsEnable": { "description": "Filter for case types that have enabled smart review tasks.\n", "in": "query", "name": "smartReviewsEnable", "required": false, "schema": { "type": "boolean" } }, "caseTypeId": { "description": "The case type unique identifier.\n", "in": "path", "name": "caseTypeId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "version": { "description": "Optional argument. If provided, the action will be performed on the specified `version`.", "in": "query", "name": "version", "schema": { "format": "int32", "type": "integer" } }, "caseTypeSmartReviewsAsOfDate": { "description": "What date to process smart review criterion. If `null`, process today. Can\nnot be a date in the future.\n", "in": "query", "name": "asOfDate", "schema": { "format": "date", "type": "string" } }, "expand": { "description": "Replace component IDs with corresponding objects", "in": "query", "name": "expand", "schema": { "default": false, "type": "boolean" } }, "includeFields": { "description": "A comma separated list of field names to include in the response.\n", "in": "query", "name": "include", "schema": { "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "associations": { "description": "Type of related object to return with the case data.\n- If `null`, no references to related objects are inserted into the response.\n- If `all`, insert an array of all relations\n- Otherwise insert array of single type.\n", "in": "query", "name": "associations", "required": false, "schema": { "enum": [ "all", "documents", "cases", "interactions", "loans" ], "type": "string" } }, "caseOutcome": { "in": "query", "name": "outcome", "required": false, "schema": { "enum": [ "all", "approved", "denied", "falsePositive", "noOutcome" ], "type": "string" } }, "caseStatus": { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "all", "initiated", "processing", "completed", "canceled", "reopened" ], "type": "string" } }, "caseStatuses": { "in": "query", "name": "statuses", "required": false, "schema": { "items": { "enum": [ "all", "initiated", "processing", "completed", "canceled", "reopened" ], "type": "string" }, "type": "array" } }, "caseStatusUpdatedBefore": { "description": "Filter by cases which have a `statusUpdatedAt` date-time from before the given value\n", "in": "query", "name": "statusUpdatedBefore", "required": false, "schema": { "format": "date-time", "type": "string" } }, "caseStatusUpdatedAfter": { "description": "Filter by cases which have a `statusUpdatedAt` date-time after the given value\n", "in": "query", "name": "statusUpdatedAfter", "required": false, "schema": { "format": "date-time", "type": "string" } }, "caseNumber": { "description": "Filter cases by external case number", "in": "query", "name": "caseNumber", "required": false, "schema": { "type": "string" } }, "caseType": { "description": "The name of the case type.\n", "in": "query", "name": "caseType", "schema": { "enum": [ "generic", "bankruptcy", "ceaseCommunication", "collection", "deceased", "disputeOfDebt", "federalEmergency", "identityTheft", "legalAction", "militaryDuty", "debtValidation", "oFACSanctionedIndividual", "creditBureauDispute" ], "type": "string" } }, "createdBefore": { "description": "Filter by cases which have a `createdAt` date-time before the given value\n", "in": "query", "name": "createdBefore", "required": false, "schema": { "format": "date-time", "type": "string" } }, "createdAfter": { "description": "Filter by cases which have a `createdAt` date-time after the given value\n", "in": "query", "name": "createdAfter", "required": false, "schema": { "format": "date-time", "type": "string" } }, "nupUpdatedNull": { "description": "Filters to cases that have been sent in the NUP file if true, otherwise filters them out if false.\n(Only applies to Bankruptcy cases)\n", "in": "query", "name": "nupUpdatedNull", "required": false, "schema": { "type": "boolean" } }, "snoozedUntilBefore": { "description": "Filter only cases with a snooze (the `snoozeUntil` value) set to expire before the specified datetime. Note that a\nsnoozed case is set to None automatically very shortly after it expires.\n", "in": "query", "name": "snoozedUntilBefore", "schema": { "format": "date-time", "type": "string" } }, "snoozedUntilAfter": { "description": "Filter only cases with a snooze (the `snoozeUntil` value) set to expire after the specified datetime.\n", "in": "query", "name": "snoozedUntilAfter", "schema": { "format": "date-time", "type": "string" } }, "owningEmployeeId": { "description": "Filter by cases which have an `owningEmployeeId` equal to the given employee\nID. If the employee ID is `null`, filter by cases which have no owning employee.\n", "in": "query", "name": "owningEmployeeId", "schema": { "type": "string" } }, "loanTypes": { "description": "Filter by a list of loan types. Only includes cases with loans of the\nspecified loan types. Special value `none` means to include cases with\nno associated loans.\n", "in": "query", "name": "loanTypes", "schema": { "items": { "enum": [ "none", "lineOfCredit", "installment" ], "type": "string" }, "type": "array" } }, "filterInteractionStatus": { "description": "Filter cases which have an associated interaction with the specified status.\n", "in": "query", "name": "interaction.status", "schema": { "items": { "$ref": "#/components/schemas/InteractionStatus" }, "type": "array" } }, "filterInteractionChannel": { "description": "Filter cases which have an associated interaction with the specified channel.\n", "in": "query", "name": "interaction.channel", "schema": { "items": { "$ref": "#/components/schemas/InteractionChannel" }, "type": "array" } }, "filterInteractionScheduledAtFromBefore": { "description": "Filter cases which have an associated interaction with a scheduled start date-time\nbefore the specified value. (i.e., the specified value is less than or equal to `scheduledAtFrom`.)\n", "in": "query", "name": "interaction.scheduledAtFromBefore", "schema": { "format": "date-time", "type": "string" } }, "filterInteractionScheduledAtFromAfter": { "description": "Filter cases which have an associated interaction with a scheduled start date-time\nafter the specified value. (i.e., the specified value is greater than or equal to `scheduledAtFrom`.)\n", "in": "query", "name": "interaction.scheduledAtFromAfter", "schema": { "format": "date-time", "type": "string" } }, "filterInteractionScheduledAtToBefore": { "description": "Filter cases which have an associated interaction with a scheduled end date-time\nbefore the specified value. (i.e., the specified value is less than or equal to `scheduledAtTo`.)\n", "in": "query", "name": "interaction.scheduledAtToBefore", "schema": { "format": "date-time", "type": "string" } }, "filterInteractionScheduledAtToAfter": { "description": "Filter cases which have an associated interaction with a scheduled end date-time\nafter the specified value. (i.e., the specified value is greater than or equal to `scheduledAtTo`.)\n", "in": "query", "name": "interaction.scheduledAtToAfter", "schema": { "format": "date-time", "type": "string" } }, "associatedDocumentId": { "description": "Filter by an associated document ID, public or external. Only includes\ncases that have been associated with the given document ID.\n", "in": "query", "name": "associatedDocumentId", "schema": { "type": "string" } }, "renderFormat": { "description": "The desired output format.", "in": "query", "name": "fmt", "schema": { "default": "html", "enum": [ "text", "html", "pdf" ], "type": "string" } }, "subject": { "in": "path", "name": "subject", "required": true, "schema": { "$ref": "#/components/schemas/InteractionSubject" } }, "parameters-companyIdQuery": { "description": "The Company ID by which to filter.", "example": "CP-AAAA-BBBB", "in": "query", "name": "companyId", "schema": { "$ref": "#/components/schemas/CompanyId" } }, "descriptorId": { "description": "ID of the Template Descriptor.", "example": "TD-AAAA-BBBB", "in": "path", "name": "descriptorId", "required": true, "schema": { "$ref": "#/components/schemas/TemplateDescriptorId" } }, "templateVersionId": { "description": "The Template Version ID.", "in": "path", "name": "templateVersionId", "required": true, "schema": { "$ref": "#/components/schemas/TemplateVersionId" } }, "includeArchived": { "description": "If set to true, includes archived objects\n", "in": "query", "name": "includeArchived", "schema": { "default": false, "type": "boolean" } }, "collectionAgencyId": { "description": "The ID of the collection agency", "in": "path", "name": "collectionAgencyId", "required": true, "schema": { "type": "string" } }, "uploadedByLender": { "description": "If `true`, only returns Credit Agency objects that have the SFTP credentials filled in, meaning the lender will upload the file to the credit agency.\n\nIf `false`, only returns Credit Agency objects that have the SFTP credentials empty, meaning Peach will upload the file to the credit agency.\n\nIf not set, includes all.\n", "in": "query", "name": "uploadedByLender", "schema": { "type": "boolean" } }, "creditAgencyId": { "description": "The ID of the credit agency", "in": "path", "name": "creditAgencyId", "required": true, "schema": { "type": "string" } }, "interactionId": { "description": "Interaction's unique identifier to track interactions for. Can be Peach\nor lender's external identifier.\n", "in": "path", "name": "interactionId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "callTranscriptionResultStatus": { "description": "The status of the transcription result.\n", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "pending", "completed", "failed" ], "type": "string" } }, "aICallTranscriptionResultIdFilter": { "description": "Filter by the AI Call Transcription Result ID.\n", "in": "query", "name": "aICallTranscriptionResultId", "required": false, "schema": { "type": "string" } }, "parameters-includeFields": { "description": "A list of additional interaction relationships to include in the response object. \n\n- When `include=borrower` the `borrower` field will be populated (otherwise it will be `null`). This\n is data describing the borrower associated with this interaction.\n- When `include=contact` the `contact`` field will be populated (otherwise it will be `null`). This is\n contact data for the contact this interaction was sent to or from.\n- When `include=lastTaskMeta` the `lastTaskMeta` field will be populated (otherwise it will be `null`).\n This is meta data about the most recently ended task associated with this interaction.\n\nYou can include multiple fields by passing multiple values, e.g., `include=borrower,contact`.\n", "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "borrower", "contact", "lastTaskMeta" ], "type": "string" }, "minItems": 1, "type": "array" } }, "contactValidate": { "description": "Validate the contact through an external API. This is only used for addresses currently.", "in": "query", "name": "validate", "required": false, "schema": { "default": true, "type": "boolean" } }, "investorId": { "description": "Unique investor identifier.", "in": "path", "name": "investorId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "settlementInstrumentId": { "description": "Unique settlement instrument identifier. Normally a bank account.", "in": "path", "name": "settlementInstrumentId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "parameters-createdBefore": { "description": "Returns loan labels created before a specific timestamp. If used in conjunction with `createdAfter`,\na time range can be created to return labels created between two timestamps.\n", "in": "query", "name": "createdBefore", "schema": { "format": "date-time", "type": "string" } }, "parameters-createdAfter": { "description": "Returns loan labels created before a specific timestamp. If used in conjunction with `createdBefore`,\na time range can be created to return labels created between two timestamps.\n", "in": "query", "name": "createdAfter", "schema": { "format": "date-time", "type": "string" } }, "loanFilter": { "description": "Filter by Loan's unique identifier. Can be Peach or lender's external identifier.\n", "in": "query", "name": "loanId", "schema": { "$ref": "#/components/schemas/AnyId" } }, "loanLabelIds": { "description": "The IDs of the loan labels", "in": "path", "name": "loanLabelIds", "required": true, "schema": { "items": { "type": "string" }, "maxItems": 100, "type": "array" } }, "loanLabelId": { "description": "The ID of the loan label", "in": "path", "name": "loanLabelId", "required": true, "schema": { "type": "string" } }, "loanTapeTypeId": { "description": "The ID of the loan tape type", "in": "path", "name": "loanTapeTypeId", "required": true, "schema": { "type": "string" } }, "untokenize": { "description": "Untokenize any tokenized fields if the calling user has the applicable permission.", "in": "query", "name": "untokenize", "schema": { "default": false, "type": "boolean" } }, "loanTapeId": { "description": "The ID of the loan tape", "in": "path", "name": "loanTapeId", "required": true, "schema": { "type": "string" } }, "loanTypeId": { "description": "The loan type identifier.", "in": "path", "name": "loanTypeId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "sendChannels": { "description": "If specified, only include notification types with at least one of the specified `sendChannels`.\nIf not provided, including any notification types regardless of the `sendChannels`.\n", "in": "query", "name": "sendChannels", "schema": { "items": { "$ref": "#/components/schemas/ValidInteractionChannel" }, "type": "array" } }, "repaymentNotificationTypeId": { "description": "The notification type identifier.", "in": "path", "name": "repaymentNotificationTypeId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "loanId": { "description": "The unique identifier of the Loan we wish to retrieve. Can be\nPeach or lender's external identifier.\n", "in": "path", "name": "loanId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "promiseToPayPlanId": { "description": "The identifier of a promise to pay plan.\n", "in": "path", "name": "promiseToPayPlanId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "parentMerchantId": { "description": "The parent merchant identifier. Used to represent hierarchy of merchant sub entities.\nCan be Peach or lender's external identifier.\n", "in": "query", "name": "parentMerchantId", "required": false, "schema": { "$ref": "#/components/schemas/AnyId" } }, "merchantId": { "description": "A lender's identifier for the merchant.", "in": "path", "name": "merchantId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "paymentProcessorId": { "description": "The payment processor ID.", "in": "path", "name": "paymentProcessorId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "achFileId": { "description": "The ACH File upload monitoring record ID.", "in": "path", "name": "achFileId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "fundingInstrumentId": { "description": "Unique funding instrument identifier. Normally a bank account.", "in": "path", "name": "fundingInstrumentId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "personId": { "description": "A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.\n", "in": "path", "name": "personId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "caseId": { "description": "The case object unique identifier.", "in": "path", "name": "caseId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "workflowStepId": { "description": "The workflow step ID", "in": "path", "name": "workflowStepId", "required": true, "schema": { "type": "string" } }, "workflowWorkitemId": { "description": "The workflow work item ID", "in": "path", "name": "workflowWorkitemId", "required": true, "schema": { "type": "string" } }, "promoProgramTypeId": { "description": "The promotional program type identifier.", "in": "path", "name": "promoProgramTypeId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "taskWorkerPairingConfigSortBy": { "description": "Which fields to sort by", "in": "query", "name": "sortBy", "required": false, "schema": { "items": { "default": [ "+priority" ], "enum": [ "id", "+id", "-id", "priority", "-priority", "+priority", "createdAt", "+createdAt", "-createdAt" ], "type": "string" }, "type": "array" } }, "taskWorkerPairingConfigId": { "in": "path", "name": "taskWorkerPairingConfigId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "taskHistoryId": { "description": "The `id` or `sid` of the terminated task", "in": "path", "name": "taskHistoryId", "required": true, "schema": { "type": "string" } }, "taskQueueSid": { "description": "The SID of the TaskQueue with the Tasks to read.\n", "in": "query", "name": "taskQueueSid", "required": false, "schema": { "type": "string" } }, "taskAssignmentStatus": { "description": "The assignment status of the\n\nNote that the assignment status cannot be `completed` or `canceled` because\n\"unterminated\" tasks are never `completed` or `canceled`—by definition tasks\nof that status are \"terminated\".\n", "explode": false, "in": "query", "name": "assignmentStatus", "required": false, "schema": { "items": { "enum": [ "pending", "reserved", "assigned", "wrapping" ], "type": "string" }, "type": "array" }, "style": "form" }, "taskType": { "description": "Only display tasks matching any these task types\n", "explode": false, "in": "query", "name": "taskType", "required": false, "schema": { "items": { "$ref": "#/components/schemas/TaskType" }, "type": "array" }, "style": "form" }, "parameters-caseType": { "description": "Only display tasks with a case with a matching any of these case type\n", "explode": false, "in": "query", "name": "caseType", "required": false, "schema": { "items": { "$ref": "#/components/schemas/BaseCaseType" }, "type": "array" }, "style": "form" }, "parameters-caseId": { "description": "Only display tasks with a case ID which matches any of these case IDs\n", "explode": false, "in": "query", "name": "caseId", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, "supercaseId": { "description": "Only display tasks with a supercase ID which matches any of these supercase IDs\n", "explode": false, "in": "query", "name": "supercaseId", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, "parameters-interactionId": { "description": "Only display tasks with an interaction ID which matches any of these interaction IDs\n", "explode": false, "in": "query", "name": "interactionId", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, "unableToComplete": { "description": "If `true`, only display tasks which were created by an agent clicking \"Unable to Complete\".\nIf `false`, display only *other* tasks.\n", "in": "query", "name": "unableToComplete", "required": false, "schema": { "type": "boolean" } }, "taskAttrMatchExpr": { "description": "A Taskrouter expression to use for matching the task by task attributes.\n\nThis field's syntax must conform to the Twilio \"TaskRouter Expression\" syntax[1].\n\n[1] https://www.twilio.com/docs/taskrouter/expression-syntax\n", "in": "query", "name": "taskAttrMatchExpr", "required": false, "schema": { "type": "string" } }, "hasCase": { "description": "Only display tasks which have a case associated with them.\n", "in": "query", "name": "hasCase", "required": false, "schema": { "type": "boolean" } }, "hasCaseOwner": { "description": "Only display tasks which has a case with an owner when the task was published.\n\n(Note that this filters based on the data in the task object, which represents the state of the\ncase at the moment the task was published.)\n", "in": "query", "name": "hasCaseOwner", "required": false, "schema": { "type": "boolean" } }, "taskSid": { "description": "The `sid` of the task", "in": "path", "name": "taskSid", "required": true, "schema": { "type": "string" } }, "workflowStepTypeId": { "description": "The workflow step type ID", "in": "path", "name": "workflowStepTypeId", "required": true, "schema": { "type": "string" } }, "workflowTypeId": { "description": "The workflow type ID", "in": "path", "name": "workflowTypeId", "required": true, "schema": { "type": "string" } }, "workflowWorkitemTypeId": { "description": "The work item type ID", "in": "path", "name": "workflowWorkitemTypeId", "required": true, "schema": { "type": "string" } }, "derivedFromTypeId": { "in": "query", "name": "derivedFromTypeId", "schema": { "$ref": "#/components/schemas/AnyId" } }, "codeId": { "description": "The ID of the desired code", "in": "path", "name": "codeId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "typeId": { "description": "Optional argument. If provided, will create a new type from the specified `typeId`.", "in": "query", "name": "typeId", "schema": { "format": "int32", "type": "integer" } }, "doNotInteractTypeId": { "description": "The Do Not Interact Type unique identifier.\n", "in": "path", "name": "doNotInteractTypeId", "required": true, "schema": { "type": "integer" } }, "documentUploadLinkKey": { "description": "The doc upload link key. Used to perform document upload operations without\nlogging into Peach system. This should be treated as *secret*, because anyone\nin possession of this key can upload on behalf the borrower for which it was\ncreated. Not to be confused with the `documentUploadLinkId`.\n", "in": "path", "name": "documentUploadLinkKey", "required": true, "schema": { "type": "string" } }, "documentDescriptorId": { "description": "The document descriptor identifier.", "in": "path", "name": "documentDescriptorId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "queryTeamId": { "description": "** DEPRECATED - use `teamIds` ** Filter results to a single team.\n", "in": "query", "name": "teamId", "schema": { "$ref": "#/components/schemas/AnyId" } }, "queryTeamIds": { "description": "Filter results to employees that belong to at least one of a list of teams.", "in": "query", "name": "teamIds", "schema": { "items": { "$ref": "#/components/schemas/AnyId" }, "type": "array" } }, "queryExcludeTeamIds": { "description": "Filter results to employees that do not belong to any of a list of teams.", "in": "query", "name": "excludeTeamIds", "schema": { "items": { "$ref": "#/components/schemas/AnyId" }, "type": "array" } }, "queryManagerEmployeeId": { "description": "The employee ID of the manager", "in": "query", "name": "managerEmployeeId", "schema": { "$ref": "#/components/schemas/AnyId" } }, "queryEmployeeSearch": { "description": "The search term on which to search. It will match ANY employee when the search term matches the following:\n\n- case-insensitive matches any substring of an employee's first name\n- case-insensitive matches any substring of an employee's last name\n- if there is whitespace in the search term, split on the whitespace, and case-insensitive match the first part to any substring of an employee's first name and the second part to any substring of the last name\n- exactly matches an employee's user's ID\n- exactly matches an employee's ID\n- exactly matches an employee's external ID (prefixed with `ext-`)\n- exactly matches one of employee's role IDs\n", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, "employeeId": { "description": "The unique employee identifier.", "in": "path", "name": "employeeId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "teamId": { "description": "The unique team identifier.", "in": "path", "name": "teamId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "personFilter": { "description": "Filter by a Borrower's unique identifier. Can be Peach or lender's external identifier.\n", "in": "query", "name": "personId", "schema": { "$ref": "#/components/schemas/AnyId" } }, "periodIdQuery": { "description": "Use this to limit results to a specific periodId.", "in": "query", "name": "periodId", "schema": { "type": "string" } }, "caseFilter": { "description": "Filter by case's object unique identifier. Can be Peach or lender's external identifier.\n", "in": "query", "name": "caseId", "schema": { "$ref": "#/components/schemas/AnyId" } }, "transactionFilter": { "description": "Filter by transaction's unique identifier. Can be Peach or lender's external identifier.\n", "in": "query", "name": "transactionId", "schema": { "$ref": "#/components/schemas/AnyId" } }, "createdAtFrom": { "description": "Get events created at or after the specified time.", "in": "query", "name": "createdAtFrom", "schema": { "format": "date-time", "type": "string" } }, "createdAtTo": { "description": "Get events created before the specified time.", "in": "query", "name": "createdAtTo", "schema": { "format": "date-time", "type": "string" } }, "effectiveAtFrom": { "description": "Get events effective at or after the specified time.", "in": "query", "name": "effectiveAtFrom", "schema": { "format": "date-time", "type": "string" } }, "effectiveAtTo": { "description": "Get events effective before the specified time.", "in": "query", "name": "effectiveAtTo", "schema": { "format": "date-time", "type": "string" } }, "accrualDate": { "description": "Get events by matching accrual date. To be used for AccrueInterestEvent only.", "in": "query", "name": "accrualDate", "schema": { "format": "date", "type": "string" } }, "includeDeleted": { "description": "Include events that have been deleted.", "in": "query", "name": "includeDeleted", "schema": { "default": true, "type": "boolean" } }, "includeEventTypes": { "description": "A comma separated list of event names to return.\nEvent name queries can end with a wildcard `*` character to specify all events starting with the given string.\nFor example, `case.*` would give all case-related events.\n", "in": "query", "name": "events", "schema": { "type": "string" } }, "excludeEventTypes": { "description": "A comma separated list of event names to exclude from the response.\nEvent name queries can end with a wildcard `*` character to specify all events starting with the given string.\nFor example, `case.*` would exclude all case-related events.\n", "in": "query", "name": "excludeEvents", "schema": { "type": "string" } }, "webhookId": { "description": "The webhook ID to filter events by. This will only include events that were sent to this webhook subscription.\n", "in": "query", "name": "webhookId", "schema": { "type": "string" } }, "parameters-supercaseId": { "description": "The supercase ID to filter events by. Events that don't have this field will be filtered out.\n", "in": "query", "name": "supercaseId", "schema": { "type": "string" } }, "hasNoPerson": { "description": "If `true`, include only unassociated interactions—those not associated with a borrower.\nIf `false`, include only interactions associated with a borrower.\nIf unset, include any interaction regardless of it being associated with a borrower or not.\n", "in": "query", "name": "hasNoPerson", "schema": { "type": "boolean" } }, "channel": { "description": "Exactly match the channel over which the interaction took place.\n", "in": "query", "name": "channel", "required": false, "schema": { "items": { "$ref": "#/components/schemas/InteractionChannel" }, "type": "array" } }, "direction": { "description": "Exactly match the direction the interaction—either `inbound` or `outbound`.\n", "in": "query", "name": "direction", "required": false, "schema": { "$ref": "#/components/schemas/InteractionDirection" } }, "status": { "description": "Exactly match the status of an interaction.\n", "in": "query", "name": "status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/InteractionStatus" }, "type": "array" } }, "statusDetails": { "description": "Exactly match the status details of an interaction.\n", "in": "query", "name": "statusDetails", "required": false, "schema": { "items": { "$ref": "#/components/schemas/InteractionStatusDetails" }, "type": "array" } }, "agentOutcome": { "description": "Exactly match the `agentOutcome` of an interaction.\n", "in": "query", "name": "agentOutcome", "required": false, "schema": { "items": { "$ref": "#/components/schemas/InteractionAgentOutcome" }, "type": "array" } }, "parameters-subject": { "description": "The interaction subject value(s) by which to filter. To match interactions\nwithout a subject pass the string \"null\".\n", "in": "query", "name": "subject", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, "theme": { "in": "query", "name": "theme", "required": false, "schema": { "items": { "$ref": "#/components/schemas/InteractionTheme" }, "type": "array" } }, "caseIds": { "description": "Exactly matches one of several Peach case IDs (`CS-XXXX-XXXX`).\n", "in": "query", "name": "caseIds", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, "contentContains": { "description": "Search for an exact match in the content of the interaction\n", "in": "query", "name": "contentContains", "required": false, "schema": { "type": "string" } }, "createdAtBefore": { "description": "Filter only objects that were not created at or before the specified\ntimestamp. This timestamp is in UTC.\n", "in": "query", "name": "createdAtBefore", "schema": { "format": "date-time", "type": "string" } }, "createdAtAfter": { "description": "Filter only objects that were not created at or after the specified\ntimestamp. This timestamp is in UTC.\n", "in": "query", "name": "createdAtAfter", "schema": { "format": "date-time", "type": "string" } }, "startedAtBefore": { "description": "Filter only objects that were not started at or before the specified\ntimestamp. This timestamp is in UTC.\n", "in": "query", "name": "startedAtBefore", "schema": { "format": "date-time", "type": "string" } }, "startedAtAfter": { "description": "Filter only objects that were not started at or after the specified\ntimestamp. This timestamp is in UTC.\n", "in": "query", "name": "startedAtAfter", "schema": { "format": "date-time", "type": "string" } }, "scheduledAtFromBefore": { "description": "Include only interactions which have a `scheduledAtFrom` set to before (or equal to) this\ntimestamp. The timestamp must include a timezone (or UTC offset).\n", "in": "query", "name": "scheduledAtFromBefore", "schema": { "format": "date-time", "type": "string" } }, "scheduledAtFromAfter": { "description": "Include only interactions which have a `scheduledAtFrom` set to after (or equal to) this\ntimestamp. The timestamp must include a timezone (or UTC offset).\n", "in": "query", "name": "scheduledAtFromAfter", "schema": { "format": "date-time", "type": "string" } }, "scheduledAtToBefore": { "description": "Include only interactions which have a `scheduledAtTo` set to before (or equal to) this\ntimestamp. The timestamp must include a timezone (or UTC offset).\n", "in": "query", "name": "scheduledAtToBefore", "schema": { "format": "date-time", "type": "string" } }, "scheduledAtToAfter": { "description": "Include only interactions which have a `scheduledAtTo` set to after (or equal to) this\ntimestamp. The timestamp must include a timezone (or UTC offset).\n", "in": "query", "name": "scheduledAtToAfter", "schema": { "format": "date-time", "type": "string" } }, "createdBy": { "description": "The User ID or Employee ID of the user which created the interaction.\n\nIf `null` is specified then match all interactions with `createdBy` of `null`.\n", "in": "query", "name": "createdBy", "required": false, "schema": { "nullable": true, "type": "string" } }, "hasVoicemail": { "description": "If `true`, include only interactions with voicemails—only valid for `channel=voice`case.\nIf `false`, include only interactions without voicemails.\nIf unset, then include any interaction regardless of it having voicemail or not.\n\nNote that a voicemail is different from a call recording. A voicemail is an audio message\nleft by a caller when no pickup by the company was possible. e.g., the call was made while the office was\nclosed or while there were no agents available to answer the call.\n", "in": "query", "name": "hasVoicemail", "required": false, "schema": { "type": "boolean" } }, "hasRecording": { "description": "If `true` match only interactions with call recordings—only valid for `channel=voice`.\nIf `false` match only interactions without call recordings.\nIf unset, match any interaction regardless of it have a recording or not.\n\nNote that a call recording is when an agent chooses to record a call, which is\ndifferent from a voicemail.\n", "in": "query", "name": "hasRecording", "required": false, "schema": { "type": "boolean" } }, "sensitive": { "description": "If `true`, include only interactions with the `sensitive` property set to `true`.\nIf `false`, include only interactions with the `sensitive` property set to `false`.\nIf unset, include any interaction regardless of `sensitive` property.\n", "in": "query", "name": "sensitive", "required": false, "schema": { "nullable": true, "type": "boolean" } }, "isExternal": { "description": "If `true`, include only interactions with the `isExternal` property set to `true`.\nIf `false`, include only interactions with the `isExternal` property set to `false`.\nIf unset, include any interaction regardless of `isExternal` property.\n", "in": "query", "name": "isExternal", "required": false, "schema": { "nullable": true, "type": "boolean" } }, "searchable": { "description": "If `true`, format the entire response as one suitable for an ElasticSearch search index.", "in": "query", "name": "searchable", "schema": { "default": false, "type": "boolean" } }, "noteCategories": { "description": "Filters by the given note categories\n", "in": "query", "name": "categories", "schema": { "items": { "$ref": "#/components/schemas/NoteCategory" }, "type": "array" } }, "notePinned": { "description": "If `true`, show only pinned notes. If `false`, exclude them. If\n`null`, do no filtering.\n", "in": "query", "name": "pinned", "schema": { "default": null, "nullable": true, "type": "boolean" } }, "disposition": { "description": "Tells the response from the file download to set the `Content-Disposition` header\nto the given value.\n- `attachment` means \"download the file\"\n- `inline` means \"open the file in the default manner\". e.g., if the file were an\n `.mp3` the browser's default audio player would open.\n", "in": "query", "name": "disposition", "schema": { "enum": [ "inline", "attachment" ], "type": "string" } }, "returnUrl": { "description": "If `true`, will return a URL to the content instead of redirecting to the content.", "in": "query", "name": "returnUrl", "required": false, "schema": { "default": false, "type": "boolean" } }, "APIKeyStatus": { "in": "query", "name": "status", "required": false, "schema": { "default": "active", "enum": [ "active", "inactive" ], "type": "string" } }, "APIKeyId": { "description": "The API key id.", "in": "path", "name": "keyId", "required": true, "schema": { "type": "string" } }, "indexRateId": { "description": "The index rate identifier. Can be Peach or lender's external identifier.", "in": "path", "name": "indexRateId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "fieldsGetLoans": { "description": "\n The result fields that will be fetched:\n\n `all` - Fetch all fields.\n\n `idsOnly` - Fetch only the following fields: `id`, `externalId`, `loanTypeId`, `mainBorrowerId`, `mainBorrowerExternalId`, `lockStatus`, and `migrationStatus`.", "in": "query", "name": "fields", "required": false, "schema": { "default": "all", "enum": [ "all", "idsOnly" ], "type": "string" } }, "loanStatuses": { "description": "A comma separated list of loan statuses to filter by", "in": "query", "name": "statuses", "required": false, "schema": { "items": { "enum": [ "all", "active", "pending", "originated", "declined", "frozen", "accelerated", "chargedOff", "paidOff", "canceled" ], "type": "string" }, "type": "array" } }, "managedByPeach": { "description": "If passed, only returns loans with a loan type with \"managed by peach\" set to this value.\n", "in": "query", "name": "managedByPeach", "schema": { "nullable": true, "type": "boolean" } }, "includeAdditionalBorrowers": { "description": "If set to `true`, include the `addtionalBorrowers` field containing information\nabout other borrowers related to this loan, e.g., cosigner, coborrowers, and applicants.\n", "in": "query", "name": "includeAdditionalBorrowers", "required": false, "schema": { "default": false, "type": "boolean" } }, "loanLabels": { "description": "A comma separated list of loan labels to filter by", "in": "query", "name": "labels", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, "updatedAtBefore": { "description": "Filter only objects that were not updated at or before the specified\ntimestamp. This timestamp is in UTC.\n", "in": "query", "name": "updatedAtBefore", "schema": { "format": "date-time", "type": "string" } }, "updatedAtAfter": { "description": "Filter only objects that were not updated at or after the specified\ntimestamp. This timestamp is in UTC.\n", "in": "query", "name": "updatedAtAfter", "schema": { "format": "date-time", "type": "string" } }, "originatedAtAfter": { "description": "Filter only objects that were not originated at or after the specified\ntimestamp. This timestamp is in UTC.\n", "in": "query", "name": "originatedAtAfter", "schema": { "format": "date-time", "type": "string" } }, "originatedAtBefore": { "description": "Filter only objects that were not originated at or before the specified\ntimestamp. This timestamp is in UTC.\n", "in": "query", "name": "originatedAtBefore", "schema": { "format": "date-time", "type": "string" } }, "activatedAtBefore": { "description": "Filter only objects that were not activated at or before the specified\ntimestamp. This timestamp is in UTC.\n", "in": "query", "name": "activatedAtBefore", "schema": { "format": "date-time", "type": "string" } }, "activatedAtAfter": { "description": "Filter only objects that were not activated at or after the specified\ntimestamp. This timestamp is in UTC.\n", "in": "query", "name": "activatedAtAfter", "schema": { "format": "date-time", "type": "string" } }, "sortByForLoans": { "description": "The data attributes by which to sort the results.", "in": "query", "name": "sortBy", "required": false, "schema": { "items": { "enum": [ "createdAt", "+createdAt", "-createdAt", "updatedAt", "+updatedAt", "-updatedAt", "originatedAt", "+originatedAt", "-originatedAt", "activatedAt", "+activatedAt", "-activatedAt" ], "type": "string" }, "type": "array" } }, "loansDueDate": { "description": "If passed, only returns loans with a due date equal to this value.", "in": "query", "name": "dueDate", "required": false, "schema": { "format": "date", "type": "string" } }, "notificationTypeId": { "description": "The Notification Type unique identifier.\n", "in": "path", "name": "notificationTypeId", "required": true, "schema": { "type": "integer" } }, "operationId": { "description": "Operation ID\n", "in": "path", "name": "operationId", "required": true, "schema": { "maxLength": 32, "minLength": 32, "type": "string" } }, "skipConnectionTest": { "description": "Skip SFTP connection test. This is not recommended - use only after consulting with Peach.", "in": "query", "name": "skipConnectionTest", "required": false, "schema": { "default": false, "type": "boolean" } }, "borrowerStatus": { "description": "Status of borrower(s).", "in": "query", "name": "status", "schema": { "enum": [ "active", "inactive" ], "type": "string" } }, "borrowerType": { "description": "Exactly match the type of borrower.", "in": "query", "name": "borrowerType", "schema": { "enum": [ "business", "person" ], "type": "string" } }, "queryIds": { "description": "List of IDs.", "explode": false, "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, "_hasTheWords": { "description": "Performs fuzzy matching on all fuzzy-matchable search fields and exact matching on all\nexact-matchable search fields.\n\nFor example, `_hasTheWords=Rob` will match a `firstName` of `Robby` a `lastName` of\n`Roberts` and street address of `123 Robinson Dr`.\n", "in": "query", "name": "_hasTheWords", "required": false, "schema": { "type": "string" } }, "_notTheWords": { "description": "Performs fuzzy matching on all fuzzy-matchable search fields and exact matching on all\nexact-matchable search fields, and ensure that entries matching that search will not\nappear in results.\n\nFor example, `_notTheWords=Rob` will match a `firstName` of `Robby` a `lastName` of\n`Roberts` and street address of `123 Robinson Dr` and ensure those results are not\nincluded in results.\n", "in": "query", "name": "_notTheWords", "required": false, "schema": { "type": "string" } }, "address": { "description": "Fuzzy matches addresses associated with a borrower. For example `address=fake` will match an\n`addressLine1` of `123 Fake St` as well as a city of `Fakeville`.\n\nNote that states are stored as their abbreviations, so you *must* search with\nthe abbreviation to match. For example, `address=MO` will match Missouri, but\n`address=Missouri` will not.\n", "in": "query", "name": "address", "required": false, "schema": { "type": "string" } }, "bankruptcyCourtCase": { "description": "Exactly matches a bankruptcy court case ID.\n", "in": "query", "name": "bankruptcyCourtCase", "required": false, "schema": { "type": "string" } }, "businessName": { "description": "Fuzzy matches the `businessName` or `businessLegalName` of business borrowers—never matches a person.\n", "in": "query", "name": "businessName", "required": false, "schema": { "type": "string" } }, "components-parameters-caseId": { "description": "Exactly matches a case ID. Can be either the Peach ID (like `CS-XXXX-XXXX`) or\nthe external ID.\n", "in": "query", "name": "caseId", "required": false, "schema": { "type": "string" } }, "city": { "description": "Fuzzy match the city in any of a borrower's addresses.\n", "in": "query", "name": "city", "required": false, "schema": { "type": "string" } }, "dateOfBirth": { "description": "Exactly matches a borrower's date of birth. Specified like `YYYY-MM-DD`.\n", "in": "query", "name": "dateOfBirth", "required": false, "schema": { "format": "date", "type": "string" } }, "email": { "description": "Fuzzy matches any of a borrower's email addresses.\n", "in": "query", "name": "email", "required": false, "schema": { "type": "string" } }, "emailExact": { "description": "Exactly matches any of a borrower's email addresses.\n", "in": "query", "name": "emailExact", "required": false, "schema": { "type": "string" } }, "employeeEmail": { "description": "Fuzzy matches any of a business borrower's employees' email addresses.\n", "in": "query", "name": "employeeEmail", "required": false, "schema": { "type": "string" } }, "employeeEmailExact": { "description": "Exactly matches any of a business borrower's employees' email addresses.\n", "in": "query", "name": "employeeEmailExact", "required": false, "schema": { "type": "string" } }, "employeePhone": { "description": "Exactly matches any of a business borrower's employees' phone numbers.\n\nNote that Peach currently only supports US phone numbers.\n\nYou may search with any US phone number format. For example `(570)123-1234`, `+15701231234`\nare all treated as identical `570-123-1234` numbers.\n", "in": "query", "name": "employeePhone", "required": false, "schema": { "type": "string" } }, "employeeName": { "description": "Fuzzy matches a business borrower's employee's name. This will never match a person borrower.\n", "in": "query", "name": "employeeName", "required": false, "schema": { "type": "string" } }, "firstName": { "description": "Fuzzy matches a borrower's first name.\n", "in": "query", "name": "firstName", "required": false, "schema": { "type": "string" } }, "firstNamePartial": { "description": "Exactly matches a substring of the borrower's first name.\n\nFor example, if a borrower's first name were 'William',\n- `firstNamePartial=Will` would match because it is exactly contained in the first name.\n- `firstNamePartial=lia` would match because it is exactly contained in the first name.\n- `firstNamePartial=Bill` would NOT match because, while close, it is not exactly contained in the first name.\n", "in": "query", "name": "firstNamePartial", "required": false, "schema": { "type": "string" } }, "fullName": { "description": "Fuzzy matches all parts of a borrower's full name. (If the borrower is a business this will also\nmatch against the business name and business legal name.)\n", "in": "query", "name": "fullName", "required": false, "schema": { "type": "string" } }, "incorporatedState": { "description": "Exactly matches the `incorporatedState` of business borrowers.\n", "in": "query", "name": "incorporatedState", "required": false, "schema": { "type": "string" } }, "id": { "description": "Exactly matches a borrower's ID. Can be either the Peach ID (like `BO-XXXX-XXXX`) or\nthe external ID.\n", "in": "query", "name": "id", "required": false, "schema": { "type": "string" } }, "components-parameters-interactionId": { "description": "Exactly matches the ID of an interaction sent to or receieved from the\nborrower. Can be either the Peach ID (like `IN-XXXX-XXXX`) or the\nexternal ID.\n", "example": "IN-1234-ABCD", "in": "query", "name": "interactionId", "required": false, "schema": { "type": "string" } }, "lastName": { "description": "Fuzzy matches a borrower's last name.\n", "in": "query", "name": "lastName", "required": false, "schema": { "type": "string" } }, "lastNamePartial": { "description": "Exactly matches a substring of the borrower's last name, following the\nsame rules as for `firstNamePartial`.\n", "in": "query", "name": "lastNamePartial", "required": false, "schema": { "type": "string" } }, "legalRepFirstName": { "description": "Fuzzy match the first name of any of a borrower's legal representatives.\n", "in": "query", "name": "legalRepFirstName", "required": false, "schema": { "type": "string" } }, "legalRepLastName": { "description": "Fuzzy match the last name of any of a borrower's legal representatives.\n", "in": "query", "name": "legalRepLastName", "required": false, "schema": { "type": "string" } }, "legalRepEmail": { "description": "Fuzzy match any email of any of a borrower's legal representatives.\n", "in": "query", "name": "legalRepEmail", "required": false, "schema": { "type": "string" } }, "legalRepPhone": { "description": "Exactly match any phone number of any of a borrower's legal representatives.\n\nNote that Peach currently only supports US phone numbers.\n\nYou may search with any US phone number format. For example `(570)123-1234`, `+15701231234`\nare all treated as identical `570-123-1234` numbers.\n", "in": "query", "name": "legalRepPhone", "required": false, "schema": { "type": "string" } }, "parameters-loanId": { "description": "Exactly matches a loan's ID. Can be either the Peach ID (like `LN-XXXX-XXXX`) or\nthe external ID.\n", "example": "LN-1234-ABCD", "in": "query", "name": "loanId", "required": false, "schema": { "type": "string" } }, "loanIdPartial": { "description": "Exactly matches a substring of the loan's external ID.\n\nFor example, if a loan's external ID were `6eeab840-3cbc-4c40-a19b-df3e9c040a54`,\n- `loanIdPartial=6eeab840` would match because it is exactly contained in the external ID.\n- `loanIdPartial=cbc-4c40-a1` would match because it is exactly contained in the external ID.\n- `loanIdPartial=9bdf3e` would NOT match because, while close, it is not exactly contained in the external ID.\n", "example": null, "in": "query", "name": "loanIdPartial", "required": false, "schema": { "type": "string" } }, "maidenName": { "description": "Fuzzy matches a borrower's maiden name.\n", "in": "query", "name": "maidenName", "required": false, "schema": { "type": "string" } }, "maidenNamePartial": { "description": "Exactly matches a substring of the borrower's maiden name, following the\nsame rules as for `firstNamePartial`.\n", "in": "query", "name": "maidenNamePartial", "required": false, "schema": { "type": "string" } }, "middleName": { "description": "Fuzzy matches a borrower's middle name.\n", "in": "query", "name": "middleName", "required": false, "schema": { "type": "string" } }, "middleNamePartial": { "description": "Exactly matches a substring of the borrower's middle name, following the\nsame rules as for `firstNamePartial`.\n", "in": "query", "name": "middleNamePartial", "required": false, "schema": { "type": "string" } }, "paymentMethod": { "description": "Exactly match the last four digits of the borrower's payment methods on file.\n", "in": "query", "name": "paymentMethod", "required": false, "schema": { "type": "string" } }, "phone": { "description": "Exactly matches any of a borrower's phone numbers.\n\nNote that Peach currently only supports US phone numbers.\n\nYou may search with any US phone number format. For example `(570)123-1234`, `+15701231234`\nare all treated as identical `570-123-1234` numbers.\n", "in": "query", "name": "phone", "required": false, "schema": { "type": "string" } }, "postalCode": { "description": "Exactly match the postal code in any of a borrower's addresses.\n", "in": "query", "name": "postalCode", "required": false, "schema": { "type": "string" } }, "state": { "description": "Exactly match the state (as an abbreviation) for any of a borrower's addresses.\n\nNote that the full name of a state will NOT match.\n", "in": "query", "name": "state", "required": false, "schema": { "type": "string" } }, "taxId": { "description": "Exactly matches the last four digits of any of the borrower's tax ID document numbers.\nThe Tax ID document is either a Social Security Number (SSN), an Individual Taxpayer\nIdentification Number (ITIN), or a passport number.\n", "in": "query", "name": "taxId", "required": false, "schema": { "type": "string" } }, "_forceIndex": { "description": "For testing new search systems before wider deploy, specify the index to use for searching.\n", "in": "query", "name": "_forceIndex", "required": false, "schema": { "type": "string" } }, "includeIdentity": { "description": "If set to true, includes the primary identity of the borrower. Use of this flag requires the `person:read.sensitive` permission.\n", "in": "query", "name": "includeIdentity", "schema": { "default": false, "type": "boolean" } }, "removeObjectType": { "description": "Type of object to remove from the case.\n", "in": "query", "name": "objectType", "required": true, "schema": { "enum": [ "document", "case", "interaction", "loan", "transaction" ], "type": "string" } }, "removeObjectId": { "description": "Peach unique identifier for the associated object to remove from the case.", "example": "LN-AAAA-BBBB", "in": "query", "name": "objectId", "required": true, "schema": { "type": "string" } }, "relation": { "description": "Label for a relationship between entities. Both `causes` and `blocks` are assumed to be directional, while the\ngeneric `related` is non-directional,\n", "in": "query", "name": "relation", "required": false, "schema": { "default": "related", "enum": [ "causes", "blocks", "duplicate", "related" ], "type": "string" } }, "doNotInteractId": { "description": "The Do Not Interact object unique identifier.\n", "in": "path", "name": "doNotInteractId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "caseEscalationId": { "description": "The case escalation object unique identifier.", "in": "path", "name": "caseEscalationId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "caseIdQuery": { "description": "Optional case ID to be recorded with the change.\n", "in": "query", "name": "caseId", "schema": { "$ref": "#/components/schemas/AnyId" } }, "contactCollidesWithEmail": { "description": "Filters for contacts which would collide with this email if it were used\nto create a new borrower contact.\n", "in": "query", "name": "collidesWithEmail", "required": false, "schema": { "type": "string" } }, "contactCollidesWithPhone": { "description": "Filters for contacts which would collide with this phone number if it were used\nto create a new borrower contact.\n", "in": "query", "name": "collidesWithPhone", "required": false, "schema": { "type": "string" } }, "contactType": { "description": "The contact type to filter by.", "in": "query", "name": "contactType", "required": false, "schema": { "$ref": "#/components/schemas/ContactType" } }, "contactAffiliation": { "description": "The contact affiliation to filter by.", "in": "query", "name": "affiliation", "schema": { "$ref": "#/components/schemas/ContactAffiliation" } }, "contactLabel": { "description": "The contact label to filter by.", "in": "query", "name": "label", "schema": { "$ref": "#/components/schemas/ContactLabel" } }, "contactStatus": { "description": "The contact status to filter by.", "in": "query", "name": "status", "schema": { "$ref": "#/components/schemas/ContactStatus" } }, "contactIncludeArchived": { "description": "Include archived contacts into the result.", "in": "query", "name": "includeArchived", "schema": { "default": false, "type": "boolean" } }, "contactIncludeLegal": { "description": "Whether to include legal representation contact objects.\n", "in": "query", "name": "includeLegal", "schema": { "default": true, "type": "boolean" } }, "receiveTextMessages": { "description": "If passed, only returns contacts with receiveTextMessages set to that value.", "in": "query", "name": "receiveTextMessages", "required": false, "schema": { "type": "boolean" } }, "contactValue": { "description": "The value of the contact to filter by.", "in": "query", "name": "value", "schema": { "type": "string" } }, "powerOfAttorney": { "description": "If passed, only returns contacts with `powerOfAttorney` set to that value.", "in": "query", "name": "powerOfAttorney", "required": false, "schema": { "type": "boolean" } }, "authorizedThirdParty": { "description": "If passed, only returns contacts with `authorizedThirdParty` set to that value.", "in": "query", "name": "authorizedThirdParty", "required": false, "schema": { "type": "boolean" } }, "confirmationCode": { "description": "The previously emailed or texted confirmation code.", "in": "query", "name": "confirmationCode", "required": false, "schema": { "pattern": "^\\d{6}$", "type": "string" } }, "contactId": { "description": "The contact ID.", "in": "path", "name": "contactId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "documentUploadLinkId": { "description": "The doc upload link ID. Used for identifying the resource in the API.\nNot to be confused with the `documentUploadLinkKey`.\n", "in": "path", "name": "documentUploadLinkId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "DeleteSource": { "description": "When `true`, set `deletedAt` on the source document to the current\ntime. This prevents it from appearing in future get documents requests.\n", "in": "query", "name": "deleteSource", "schema": { "default": false, "type": "boolean" } }, "includeArchivedIdentities": { "description": "If set to true, includes archived identities\n", "in": "query", "name": "includeArchived", "schema": { "default": false, "type": "boolean" } }, "personIdentityId": { "description": "An identity's unique identifier.\n", "in": "path", "name": "personIdentityId", "required": true, "schema": { "type": "string" } }, "interactionsSortBy": { "description": "The field(s) to sort by.\n\nAll fields can be prefixed with a `-` to indicate the sort should be in descending order,\nor with a `+` to indicate the sort should be in ascending order. (Without specifying\nthe order is descending.)\n\nThe valid sort by field names are:\n\n`id` — order by the object creation order.\n`createdAt` — order by the `createdAt` field.\n`startedAt` — order by the `startedAt` field.\n`holdDuration` — order by the duration of the voice call on-hold (the `holdDuration` field.)\n`contactName` — order by the `name` field of the contact for the interaction.\n`scheduledAtFrom` — order by the `scheduledAtFrom` field.\n`scheduledAtTo` — order by the `scheduledAtTo` field.\n`channel` — order by the `channel` field.\n`direction` — order by the `direction` field.\n`status` — order by the `status` field.\n`createdBy.employeeFirstName` — order by the `firstName` field of the employee which created the interaction (only if creator was an employee).\n`createdBy.employeeLastName` — order by the `lastName` field of the employee which created the interaction (only if creator was an employee).\n`createdBy.employeeEmail` — order by the `email` field of the employee which created the interaction (only if creator was an employee).\n`createdBy.employeeDisplayName` - order by the full name (`{firstName} {lastName}`) or, if absent, the `email` of the employee whihch created the interaction (only if creator was an employee).\n`createdBy.employeeFullNameOrEmail` — **DEPRECATED** alias for `createdBy.employeeDisplayName`\n", "in": "query", "name": "sortBy", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, "legalRepresentativeId": { "description": "The legal representative object unique identifier.\n", "in": "path", "name": "legalRepresentativeId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "filterLoanStatus": { "in": "query", "name": "status", "required": false, "schema": { "items": { "enum": [ "all", "active", "pending", "originated", "declined", "frozen", "accelerated", "chargedOff", "paidOff", "canceled" ], "type": "string" }, "type": "array" } }, "chargeOffBalance": { "description": "This filter is only applicable if `chargedOff` is one of the statuses.\nIn other words, this filter will only be applied on loans with `status=chargedOff`.\n\n`all` - all `chargedOff` loans will be returned (honoring other filters).\n\n`hasBalance` - only `chargedOff` loans with outstanding balance greater than zero will be returned.\n\n`zeroBalance` - only `chargedOff` loans with zero outstanding balance will be returned.\n", "in": "query", "name": "chargeOffBalance", "required": false, "schema": { "enum": [ "all", "hasBalance", "zeroBalance" ], "type": "string" } }, "forceLoanUpdate": { "description": "Override that enables the update of a borrower's address of a loan.\n", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, "syncGeneric": { "description": "Make the process synchronous.", "in": "query", "name": "sync", "schema": { "default": false, "type": "boolean" } }, "advanceStatus": { "description": "The status of the advances.", "in": "query", "name": "status", "schema": { "enum": [ "scheduled", "pending", "settled", "canceled" ], "type": "string" } }, "advanceId": { "description": "The advance identifier.", "in": "path", "name": "advanceId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "autopayExpectedPaymentStatus": { "description": "The comma separated list of `status` values of autopay expected payments to include in the results, which are merged by date.\nAll autopay expected payments can still be accessed in the `individualEntries` field.\n", "explode": false, "in": "query", "name": "statuses", "schema": { "default": [ "booked", "modified" ], "items": { "enum": [ "booked", "skipped", "canceled", "modified", "draft", "processed" ], "type": "string" }, "type": "array" }, "style": "form" }, "autopayCancellationReason": { "description": "The cancellation reason.\n", "in": "query", "name": "cancellationReason", "required": false, "schema": { "default": "canceledByUser", "enum": [ "invalidPaymentMethod", "paymentMethodRemoved", "tooManyFailedAttempts", "loanFrozen", "loanAccelerated", "loanChargedOff", "loanPaidOff", "canceledByUser", "loanTermsChanged" ], "type": "string" } }, "isRounded": { "description": "If true, balances will be rounded to the closes 1 cent.", "in": "query", "name": "isRounded", "schema": { "type": "boolean" } }, "skipYtd": { "description": "If true, skip year-to-date calculations.", "in": "query", "name": "skipYtd", "schema": { "type": "boolean" } }, "fast": { "description": "Perform a faster query that returns a pre-defined subset of attributes. When this query parameter is used, the `toEffectiveAt`\nparameter is ignored and only real-time balances are returned.\n\nTo configure the subset of attributes, please contact the Peach team.\n", "in": "query", "name": "fast", "schema": { "default": false, "type": "boolean" } }, "toEffectiveDate": { "description": "Last day for which to fetch balances", "in": "query", "name": "toEffectiveDate", "schema": { "format": "date", "type": "string" } }, "forceLoanCancel": { "description": "Override that enables the cancellation of active loans not managed by Peach. Requires the `loan:cancel.force` permission.\nForced cancellation should only be used for testing purposes.\n", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, "clearAllExternalIdsLoanCancel": { "description": "If `true`, will clear all related loan, draws (if LOC), purchases (if LOC), transactions, and dynamic fees external IDs. This will emit a `externalid.changed` event for all impacted objects.\n\nNOTE: If `sync=true`, there is a max limit of 1000 external IDs that can be cleared synchronously.\nIf there are more than 1000, the request will fail with a HTTP 408 status code. You should instead set `clearAllExternalIds=false` and call the individual endpoints to clear external IDs.\n", "in": "query", "name": "clearAllExternalIds", "schema": { "default": false, "type": "boolean" } }, "syncLoanCancel": { "description": "Today, `sync` only controls the clearing of external IDs when cancelling a loan when `clearAllExternalIds` is `true`.\n\n`true` - Clears the external IDs of the loan, draws, purchases, transactions, and dynamic fees up to the max limit of 1000.\nIf there are more than 1000, the request will fail with a HTTP 408 status code.\n\n`false` - will clear all external IDs asynchronously. This is not yet supported.\n", "in": "query", "name": "sync", "schema": { "default": true, "type": "boolean" } }, "clearExternalIdGeneric": { "description": "If `true`, will clear the external ID for the object.\n", "in": "query", "name": "clearExternalId", "schema": { "default": false, "type": "boolean" } }, "showPan": { "description": "Set to `true` to get the full PAN in the response. Special permission is required.", "in": "query", "name": "showPan", "required": false, "schema": { "type": "boolean" } }, "showCvv": { "description": "Set to `true` to get the full CVV2 number in the response. Special permission is required.", "in": "query", "name": "showCvv", "required": false, "schema": { "type": "boolean" } }, "refresh": { "description": "If `true`, the Peach system will make new API calls to the card issuer to get the most recent card details and balances,\nand will store the new details in the Peach database. Otherwise, the Peach system will return the most recent details from its database.\n", "in": "query", "name": "refresh", "required": false, "schema": { "type": "boolean" } }, "cardId": { "description": "The ID of the card. Can be Peach or lender's external identifier.", "in": "path", "name": "cardId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "servicedBy": { "in": "query", "name": "servicedBy", "required": true, "schema": { "$ref": "#/components/schemas/LoanServicer" } }, "effectiveDate": { "in": "query", "name": "effectiveDate", "schema": { "format": "date", "type": "string" } }, "customPaymentPlanStatusQuery": { "description": "Use this to filter a search for custom payment plans that are `active`, `inactive` or `canceled`.\n", "in": "query", "name": "status", "schema": { "enum": [ "active", "inactive", "canceled" ], "type": "string" } }, "paymentPlanId": { "description": "The identifier of the payment plan.", "in": "path", "name": "paymentPlanId", "required": true, "schema": { "type": "string" } }, "isClosed": { "description": "Filter for draws with `isClosed` value", "in": "query", "name": "isClosed", "required": false, "schema": { "type": "boolean" } }, "isAmortized": { "description": "Filter for amortized or non-amortized draws", "in": "query", "name": "isAmortized", "required": false, "schema": { "type": "boolean" } }, "startedBefore": { "description": "Filter for draws started before a date", "in": "query", "name": "startedBefore", "required": false, "schema": { "format": "date", "type": "string" } }, "drawId": { "description": "The draw identifier.", "in": "path", "name": "drawId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "skipInterestAccrual": { "description": "If true, skip automatic interest accrual to catch up if it is missing.", "in": "query", "name": "skipInterestAccrual", "schema": { "type": "boolean" } }, "effectiveRatesPeriodIdsQuery": { "description": "List of period IDs to specify the requested dates.\n\nThis is an alternative to using `fromDate` and `toDate` to specify the requested dates;\ninstead of specifying a range of dates, every date falling within all\nof the specified periods will be returned. Note this might result in non-consecutive dates.\n\nCannot be used in conjunction with `fromDate` or `toDate`.\n", "in": "query", "name": "periodIds", "schema": { "items": { "type": "string" }, "type": "array" } }, "effectiveRatesPeriodDueDatesQuery": { "description": "List of period due dates to specify the requested dates.\n\nThis is an alternative to specifying the periods of concern with IDs and instead\nreferencing them by their due dates.\n\nThis is also an alternative to using `fromDate` and `toDate` to specify the requested dates;\ninstead of specifying a range of dates, every date falling within all\nof the specified periods will be returned. Note this might result in non-consecutive dates.\n\nCannot be used in conjunction with `fromDate` or `toDate`.\n", "in": "query", "name": "periodDueDates", "schema": { "items": { "format": "date", "type": "string" }, "type": "array" } }, "obligationStatusQuery": { "description": "Use this to filter a search for obligations that are `unfulfilled` or `overdue`.\n", "in": "query", "name": "status", "schema": { "enum": [ "unfulfilled", "overdue" ], "type": "string" } }, "loanPeriodFromDate": { "description": "The first date in the range to return.\nThe system will return any period for which period's `startDate` - `endDate` fully or partially overlap with `fromDate` - `toDate` range.\nBoth `fromDate` and `toDate` must be passed to get all periods in the range.\n", "in": "query", "name": "fromDate", "required": false, "schema": { "format": "date", "type": "string" } }, "loanPeriodToDate": { "description": "The last date in the range to return.\nThe system will return any period for which period's `startDate` - `endDate` fully or partially overlap with `fromDate` - `toDate` range.\nBoth `fromDate` and `toDate` must be passed to get all periods in the range.\n", "in": "query", "name": "toDate", "schema": { "format": "date", "type": "string" } }, "dueDate": { "description": "The due date of the period. The system will return the object corresponding to the period with due date equal to `dueDate`.\nIf no matching period is found, the system will return no results.\n", "in": "query", "name": "dueDate", "schema": { "format": "date", "type": "string" } }, "isOpen": { "description": "`true` means that the obligation is still \"open\" and the `obligationAmount` is not final. The obligation amount can potentially change until the\nperiod ends. `false` means that the obligation is \"sealed\" and the `obligationAmount` is final.\n", "in": "query", "name": "isOpen", "schema": { "type": "boolean" } }, "obligationId": { "description": "The obligation object unique identifier.", "in": "path", "name": "obligationId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "promoProgramId": { "description": "The promotional program identifier.", "in": "path", "name": "promoProgramId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "promoCancelReason": { "description": "The cancellation reason.\n\n `expired` - the promo expired.\n\n `disqualified` - the promo was disqualified for various\n reasons.\n\n `borrowerOptedOut` - the borrower decided to opt out from the\n promotional program.\n\n `adminError` - the promo program was added by mistake.\n", "in": "query", "name": "promoCancelReason", "required": false, "schema": { "$ref": "#/components/schemas/PromoCancelReason" } }, "purchaseTypes": { "description": "The statuses of the purchases to fetch", "in": "query", "name": "types", "required": false, "schema": { "items": { "enum": [ "regular", "refund", "cashback" ], "type": "string" }, "type": "array" } }, "purchaseStatuses": { "description": "The statuses of the purchases to fetch", "in": "query", "name": "statuses", "required": false, "schema": { "items": { "enum": [ "authorized", "pending", "settled", "canceled", "declined", "disputed" ], "type": "string" }, "type": "array" } }, "fromEffectiveAt": { "description": "Used for filtering objects such that `effectiveAt` is greater than or equal to `fromEffectiveAt`", "in": "query", "name": "fromEffectiveAt", "schema": { "format": "date-time", "type": "string" } }, "toEffectiveAt": { "description": "Used for filtering objects such that `effectiveAt` is less than or equal to `toEffectiveAt`", "in": "query", "name": "toEffectiveAt", "schema": { "format": "date-time", "type": "string" } }, "fromCreatedAt": { "description": "Used for filtering objects such that `createdAt` is greater than or equal to `fromCreatedAt`", "in": "query", "name": "fromCreatedAt", "schema": { "format": "date-time", "type": "string" } }, "toCreatedAt": { "description": "Used for filtering objects such that `createdAt` is less than or equal to `toCreatedAt`", "in": "query", "name": "toCreatedAt", "schema": { "format": "date-time", "type": "string" } }, "sortByEffectiveAt": { "description": "The data attributes by which to sort the results.", "in": "query", "name": "sortBy", "required": false, "schema": { "items": { "enum": [ "effectiveAt", "+effectiveAt", "-effectiveAt", "createdAt", "+createdAt", "-createdAt" ], "type": "string" }, "type": "array" } }, "forcePurchaseOverCreditLimit": { "description": "Allows creation of purchases, even if is above the credit limit for the line of credit.\n", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, "timelineOrdering": { "description": "The parameters used to generate a timeline of purchases. Purchases will be inserted into the timeline based on the parameters provided.\n`effectiveAt`, `createdAt`, and `authorizedAt` are available for sorting. `createdAt` will be used if any purchases would not be inserted\ninto the timeline based on the attributes provided. The full timeline will be sorted either ASC (`+`) or DESC (`-`). It cannot be sorted\nbased on individual attributes. e.g. [-effectiveAt, +authorizedAt, -createdAt] is not a valid input.\n", "in": "query", "name": "timelineOrdering", "required": false, "schema": { "items": { "enum": [ "effectiveAt", "authorizedAt", "createdAt" ], "type": "string" }, "type": "array" } }, "timelineSortOrder": { "description": "The order of the purchase timeline returned.\n- `asc` - oldest to newest\n- `desc` - newest to oldest\n", "in": "query", "name": "sortOrder", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, "purchaseId": { "description": "The purchase identifier.", "in": "path", "name": "purchaseId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "purchaseDisputeId": { "description": "The ID of the purchase dispute", "in": "path", "name": "purchaseDisputeId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "rateCapId": { "description": "The unique identifier of the Rate Cap we wish to retrieve.\n", "in": "path", "name": "rateCapId", "required": true, "schema": { "$ref": "#/components/schemas/RateCapId" } }, "rateId": { "description": "Unique identifier of an interest or promo rate.\n", "in": "path", "name": "rateId", "required": true, "schema": { "type": "string" } }, "includeDraws": { "description": "If set to true, includes the fees on all draws on the line of credit.\n", "in": "query", "name": "includeDraws", "schema": { "default": true, "type": "boolean" } }, "loanFeeId": { "description": "The loan fee identifier.", "in": "path", "name": "loanFeeId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "syncUpdateDynamicFee": { "description": "Make the process synchronous. Only relevant for `originalAmount` updates. Updating this value will trigger a replay.", "in": "query", "name": "sync", "schema": { "default": false, "type": "boolean" } }, "fromEffectiveDate": { "description": "Last day for which to fetch balances", "in": "query", "name": "fromEffectiveDate", "schema": { "format": "date", "type": "string" } }, "scraRateId": { "description": "Unique identifier of the SCRA interest rate to update or delete.\n", "in": "query", "name": "rateId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "scraSendNotice": { "description": "When set to `false`, the system will NOT send a `loanPaymentScheduleChanged` notice to the borrower.\n\nNote: Changing the loan terms will automatically cancel an existing Autopay (if enabled). A borrower, an agent or\nAPI caller needs to turn on / enable a new Autopay plan after the loan terms change is completed. If the loan has Autopay enabled:\n - When `sendNotice=false`, the system will NOT send an `autopayCanceledBySystem` notice.\n - When `sendNotice=true`, the system will send an `autopayCanceledBySystem` notice in addition to the applicable loan terms notice.\n", "in": "query", "name": "sendNotice", "required": false, "schema": { "default": true, "type": "boolean" } }, "scraCaseId": { "description": "The case object unique identifier.", "in": "query", "name": "caseId", "required": false, "schema": { "$ref": "#/components/schemas/AnyId" } }, "dueDateGet": { "description": "The due date of the period. The system will return the object corresponding to the period with\ndue date equal to `dueDate`. If no matching period is found, the system will return no results.\n", "in": "query", "name": "dueDate", "required": false, "schema": { "format": "date", "type": "string" } }, "reportingToAgency": { "description": "Filters to only loan types set up to report to this agency.", "in": "query", "name": "reportingToAgency", "schema": { "enum": [ "experian", "equifax", "transUnion", "innovis" ], "type": "string" } }, "dueDateUpdate": { "description": "The due date of the period. The system will update the object corresponding to the period with\na due date equal to `dueDate`. If no matching period is found, the system will not make any updates.\n", "in": "query", "name": "dueDate", "required": true, "schema": { "format": "date", "type": "string" } }, "dueDateDelete": { "description": "The due date of the period. The system will delete the object corresponding to the period with\na due date equal to `dueDate`. If no matching period is found, the system will not make any updates.\n", "in": "query", "name": "dueDate", "required": true, "schema": { "format": "date", "type": "string" } }, "transactionStatuses": { "in": "query", "name": "status", "required": false, "schema": { "items": { "$ref": "#/components/schemas/TransactionStatusReadOnly" }, "type": "array" } }, "queryPaymentInstrumentId": { "description": "The payment instrument identifier.", "in": "query", "name": "paymentInstrumentId", "schema": { "$ref": "#/components/schemas/AnyId" } }, "transactionType": { "in": "query", "name": "transactionType", "required": false, "schema": { "enum": [ "payment", "serviceCredit" ], "type": "string" } }, "serviceCreditTypes": { "in": "query", "name": "serviceCreditTypes", "required": false, "schema": { "items": { "$ref": "#/components/schemas/serviceCreditTypes" }, "type": "array" } }, "toEffectiveDateGeneric": { "description": "Last day for which an object's effective date must match", "in": "query", "name": "toEffectiveDate", "schema": { "format": "date", "type": "string" } }, "fromEffectiveDateGeneric": { "description": "First day for which an object's effective date must match", "in": "query", "name": "fromEffectiveDate", "schema": { "format": "date", "type": "string" } }, "sortByForTransactions": { "description": "The data attributes by which to sort the results.", "in": "query", "name": "sortBy", "required": false, "schema": { "items": { "enum": [ "appliedAt", "+appliedAt", "-appliedAt", "createdAt", "+createdAt", "-createdAt", "effectiveDate", "+effectiveDate", "-effectiveDate", "displayDate", "+displayDate", "-displayDate" ], "type": "string" }, "type": "array" } }, "transactionId": { "description": "Transaction ID. Can be Peach or lender's external identifier.", "in": "path", "name": "transactionId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "loanPeriodId": { "description": "The identifier of the period.", "in": "path", "name": "loanPeriodId", "required": true, "schema": { "type": "string" } }, "periodId": { "description": "The identifier of the period.", "in": "path", "name": "periodId", "required": true, "schema": { "type": "string" } }, "sendNotice": { "description": "When set to `true`, the system will send a `statementGenerated` notice to the borrower.\n", "in": "query", "name": "sendNotice", "schema": { "default": false, "type": "boolean" } }, "statementReason": { "description": "Reason for manually generating statement.", "in": "query", "name": "reason", "required": false, "schema": { "type": "string" } }, "parameters-status": { "description": "Filter by status. Possible values are `scheduled`, `active`, `kept`, `broken`, `canceled`.\n", "explode": true, "in": "query", "name": "status", "schema": { "items": { "enum": [ "scheduled", "active", "kept", "broken", "canceled" ], "type": "string" }, "type": "array" }, "style": "form" }, "isOverdue": { "description": "Filter by overdue status. Possible values are `true`, `false`.\n", "in": "query", "name": "isOverdue", "schema": { "enum": [ true, false ], "type": "boolean" } }, "startDateAfter": { "description": "Filter by start date after. Format: `YYYY-MM-DD`.\n", "in": "query", "name": "startDateAfter", "schema": { "format": "date", "type": "string" } }, "endDateBefore": { "description": "Filter by end date before. Format: `YYYY-MM-DD`.\n", "in": "query", "name": "endDateBefore", "schema": { "format": "date", "type": "string" } }, "promoEffectiveEndDateAfter": { "description": "Return promo programs with a `promoEffectiveEndDate` starting after the provided date.", "in": "query", "name": "promoEffectiveEndDateAfter", "schema": { "format": "date", "type": "string" } }, "statuses": { "description": "The array of statuses used for filtering if a borrower has promo programs with the given `status`. If not \npassed, by default we return all statuses\n", "in": "query", "name": "statuses", "schema": { "items": { "enum": [ "pending", "active", "exercised", "canceled" ], "type": "string" }, "type": "array" } }, "loanRefundId": { "description": "The loan refund identifier.", "in": "path", "name": "loanRefundId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "statementYear": { "description": "Only return statements from the current year.", "in": "query", "name": "year", "schema": { "type": "string" } }, "includeAllVersions": { "description": "A flag to determine if all template versions should be returned, not just the most recent / active ones.\n", "in": "query", "name": "includeAllVersions", "schema": { "default": false, "type": "boolean" } }, "includeTestVersions": { "description": "A flag to determine whether test versions should be returned. If this flag is set to \"true\",\nthe system will ignore the `includeAllVersions` attribute and return only test versions.\n", "in": "query", "name": "includeTestVersions", "schema": { "default": false, "type": "boolean" } }, "statementPubId": { "description": "The statement object unique identifier.", "in": "path", "name": "statementId", "required": true, "schema": { "pattern": "^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\\d+$", "type": "string" } }, "parameters_isExternal": { "description": "Fetch entities that are marked external.", "in": "query", "name": "isExternal", "schema": { "type": "boolean" } }, "isVirtual": { "in": "query", "name": "isVirtual", "required": false, "schema": { "type": "boolean" } }, "paymentReason": { "in": "query", "name": "paymentReason", "required": false, "schema": { "enum": [ "autoPay", "settlement", "reversal", "downPayment", "oneTimePayment", "reimbursement" ], "type": "string" } }, "retryOriginalTransactionId": { "in": "query", "name": "retryOriginalTransactionId", "required": false, "schema": { "type": "string" } }, "transactionCancelReason": { "in": "query", "name": "cancelReason", "required": false, "schema": { "$ref": "#/components/schemas/TransactionCancelReason" } }, "chargebackId": { "description": "Chargeback ID. Can be Peach or lender's external identifier.", "in": "path", "name": "chargebackId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "parameters_includeDeleted": { "description": "Include entities that are marked deleted.", "in": "query", "name": "includeDeleted", "schema": { "default": false, "type": "boolean" } }, "showFullAccountNumber": { "description": "Provide raw untokenized account details:\n`cardNumber` for cards, `accountNumber` for bank accounts, checks, wires, and money orders.\n\nRequires the `payment.instrument:read.sensitive` permission.\n", "in": "query", "name": "showFullAccountNumber", "schema": { "default": false, "type": "boolean" } }, "forcePaymentInstrument": { "description": "Overrides the results of BIN / Routing Number lookup. Requires the `payment.instrument:force` permission.\n", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, "sync": { "description": "Make the payment instrument authentication process synchronous. Only relevant for cards.\n", "in": "query", "name": "sync", "schema": { "default": false, "type": "boolean" } }, "allowDuplicates": { "description": "For external payment instruments, skip duplicate checks. Allows the creation two external payment instruments with the same last 4 digits on the same borrower.\n", "in": "query", "name": "allowDuplicates", "schema": { "default": false, "type": "boolean" } }, "paymentInstrumentId": { "description": "The payment instrument identifier.", "in": "path", "name": "paymentInstrumentId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "verificationStatus": { "description": "The comma separated list of `status` values of verifications to include in the response.\nIf not included, include all verifications.\n", "explode": false, "in": "query", "name": "status", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, "dryRun": { "description": "If `true`, then return successfully if the operation would complete successfully, but do not\nactually save the changes which would result from this operation.\n", "in": "query", "name": "dryRun", "schema": { "default": false, "type": "boolean" } }, "verificationId": { "description": "The borrower verification unique identifier.\n", "in": "path", "name": "verificationId", "required": true, "schema": { "type": "string" } }, "supercaseSortBy": { "description": "The attribute by which to sort the results.", "in": "query", "name": "sortBy", "required": false, "schema": { "items": { "enum": [ "-id", "id", "+id", "-createdAt", "createdAt", "+createdAt", "-name", "name", "+name", "-status", "status", "+status" ], "type": "string" }, "type": "array" } }, "supercaseType": { "description": "The type of the supercase", "in": "query", "name": "supercaseType", "schema": { "$ref": "#/components/schemas/SupercaseType", "default": "generic" } }, "femaDisasterNumber": { "in": "query", "name": "femaDisasterNumber", "schema": { "type": "integer" } }, "statusFilter": { "in": "query", "name": "status", "schema": { "items": { "$ref": "#/components/schemas/ProcessStatus" }, "type": "array" } }, "components-parameters-supercaseId": { "description": "The ID of the supercase", "in": "path", "name": "supercaseId", "required": true, "schema": { "type": "string" } }, "operationTypes": { "description": "List of desired operation types.\n", "in": "query", "name": "operationTypes", "required": false, "schema": { "items": { "enum": [ "update", "sendMessage", "createDoNotInteract", "deleteDoNotInteract", "sendInstructionsByTask" ], "type": "string" }, "type": "array" } }, "supercaseBulkOperationId": { "description": "Supercase bulk operation ID", "in": "path", "name": "supercaseBulkOperationId", "required": true, "schema": { "type": "string" } }, "noteId": { "description": "The ID of the note", "in": "path", "name": "noteId", "required": true, "schema": { "type": "string" } }, "publishReviewTask": { "description": "Create case update review task if `true`.\nThe task is created only when the user type is `Service`.\n", "in": "query", "name": "publishReviewTask", "schema": { "default": true, "type": "boolean" } }, "populationId": { "description": "The ID of the population", "in": "path", "name": "populationId", "required": true, "schema": { "type": "string" } }, "userId": { "description": "Unique user identifier.", "in": "path", "name": "userId", "required": true, "schema": { "$ref": "#/components/schemas/AnyId" } }, "roleId": { "description": "Unique role identifier.", "in": "path", "name": "roleId", "required": true, "schema": { "type": "string" } }, "includeContextVars": { "description": "If `true`, include all the context variables for this template.\n", "in": "query", "name": "includeContextVars", "required": false, "schema": { "default": false, "type": "boolean" } }, "includeContents": { "description": "If `true`, include the template contents, otherwise only return metadata.", "in": "query", "name": "includeContents", "required": false, "schema": { "default": true, "type": "boolean" } }, "subjectFilterQuery": { "description": "Only include templates matching these interaction subjects.", "in": "query", "name": "subject", "required": false, "schema": { "items": { "$ref": "#/components/schemas/InteractionSubject" }, "type": "array" } }, "parameters-channel": { "description": "Only include templates matching this set of interaction channels.", "in": "query", "name": "channel", "required": false, "schema": { "items": { "$ref": "#/components/schemas/InteractionChannel" }, "type": "array" } }, "verificationTypeId": { "description": "The unique borrower verification type identifier.", "in": "path", "name": "verificationTypeId", "required": true, "schema": { "type": "string" } }, "webhookSubscriptionId": { "description": "The ID of the webhook subscription", "in": "path", "name": "webhookSubscriptionId", "required": true, "schema": { "type": "string" } } }, "requestBodies": { "Plaid": { "content": { "application/json": { "schema": { "properties": { "clientId": { "description": "The Plaid `client_id` from your Plaid dashboard.", "example": "6143abc123def456", "type": "string" }, "secret": { "description": "The Plaid secret key for your environment (sandbox, development, or production)", "example": "abc123def456...", "type": "string" } }, "required": [ "clientId", "secret" ], "type": "object" } } }, "required": true }, "ExchangeTokenPost": { "content": { "application/json": { "schema": { "properties": { "userId": { "$ref": "#/components/schemas/AnyId" } }, "required": [ "userId" ], "type": "object" } } }, "required": true }, "AuthPost": { "content": { "application/json": { "schema": { "anyOf": [ { "properties": { "password": { "description": "The password to authenticate with.", "format": "password", "type": "string" }, "username": { "description": "The username to authenticated. This can be a username or an email, depending on the configuration.", "type": "string" } }, "type": "object" }, { "properties": { "exchangeToken": { "description": "Temporary exchange token generated by the /auth/exchange-token endpoint.", "type": "string" } }, "type": "object" } ] } } }, "required": true }, "BulkSenderCreate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSenderCreate" } } } }, "BulkSenderUpdate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSender" } } } }, "ContactExporterCreate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactExporter" } } } }, "ContactExporterUpdate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactExporter" } } } }, "BorrowerCampaignCreate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BorrowerCampaign" } } } }, "BorrowerCampaignUpdate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BorrowerCampaign" } } } }, "BorrowerCampaignRunCreate": { "content": { "application/json": { "schema": { "nullable": true, "properties": { "queryResultsOverride": { "description": "Instead of running the Redash query specified in the Campaign object at `queryRedashUrl`\nyou can overide that query by providing a query results override.\n\nInstead of the query being run and its results being used as campaign input, the data provided here\nis fed into the campaign as input.\n", "example": [ { "borrowerId": 1, "loanId": 101 }, { "borrowerId": 2, "loanId": 102 }, { "borrowerId": 3, "loanId": 103 } ], "type": "array" } }, "type": "object" } } } }, "BorrowerCampaignRunUpdate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BorrowerCampaignRun" } } } }, "CardIssuerPost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CardIssuer" }, { "required": [ "status", "cardIssuerType", "cardType" ] } ] } } }, "required": true }, "CardIssuerPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardIssuerPut" } } }, "required": true }, "CaseTypePost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseTypePostOnly" } } }, "required": true }, "CaseTypePut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseType" } } }, "required": true }, "CommunicatorReceiveOnlyPost": { "content": { "application/json": { "schema": { "allOf": [ { "required": [ "theme", "channel", "status" ] }, { "$ref": "#/components/schemas/Interaction" } ] } } }, "required": true }, "CollectionAgencyPost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CollectionAgencyPost" }, { "required": [ "legalName", "contactPhone", "mailingAddress" ] } ] } } }, "required": true }, "CollectionAgencyPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionAgency" } } }, "required": true }, "CreditAgencyPost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditAgency" }, { "required": [ "agencyName", "country", "dataFormat" ] }, { "properties": { "copyKeysFrom": { "$ref": "#/components/schemas/AnyId", "description": "The identifier of the agency to copy keys from." }, "enrollExistingLoans": { "default": false, "description": "Automatically enroll existing active loans for credit reporting with this agency.", "type": "boolean" } }, "type": "object" } ] } } }, "required": true }, "CreditAgencyPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAgency" } } }, "required": true }, "LoanLabelPost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LoanLabel" }, { "required": [ "name" ] } ] } } }, "required": true }, "LoanIdsPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanIdsRequest" } } }, "required": true }, "LoanLabelPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanLabel" } } }, "required": true }, "LoanTapeTypePost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TapeType" }, { "required": [ "tapeType", "tapeName", "fields" ] } ] } } }, "required": true }, "LoanTapeTypePut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseLoanTapeType" } } }, "required": true }, "LoanTapePost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LoanTape" }, { "required": [ "loanTapeTypeId", "sftpHostname" ] } ] } } }, "required": true }, "LoanTapePut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanTape" } } }, "required": true }, "MerchantPost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Merchant" }, { "required": [ "businessName" ] } ] } } }, "required": true }, "MerchantPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Merchant" } } }, "required": true }, "PromoProgramTypePost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromoProgramTypePost" } } }, "required": true }, "PromoProgramTypePut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromoProgramTypePut" } } }, "required": true }, "CodeUpdate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code" } } }, "required": true }, "CodeExecution": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeExecution" } } }, "required": true }, "DoNotInteractType": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DoNotInteractType" } } }, "required": true }, "EmployeePost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Employee" }, { "required": [ "userId" ], "type": "object" } ] } } }, "required": true }, "EmployeePut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } }, "required": true }, "EmailSignaturePut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSignatureUpdate" } } }, "required": true }, "ConvoJoin": { "content": { "application/json": { "schema": { "properties": { "joinType": { "default": "solo", "description": "The method of joining the conversation.\n\n- `solo` - only add agent to conversation if there are no other agents in conversations\n- `add` - simply add agent to conversation\n- `takeover` - remove all other agents from conversation, the add agent\n", "enum": [ "solo", "add", "takeover" ], "type": "string" } }, "type": "object" } } } }, "Note": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteRequest" } } }, "required": true }, "IndexRateAdd": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRate" } } }, "required": true }, "IndexRateUpdate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRateUpdate" } } }, "required": true }, "NotificationType": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationType" } } }, "required": true }, "PersonRequest": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Borrower" } } }, "required": true }, "PersonPutRequest": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BorrowerNoIdentity" }, { "properties": { "caseId": { "description": "An identifier for an existing case.", "type": "string" } }, "type": "object" } ] } } }, "required": true }, "CanInteract": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanInteractByContactIdentifier" } } }, "required": true }, "CasePost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Case" } } }, "required": true }, "CasePut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePut" } } }, "required": true }, "AssociationPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseAssociation" } } }, "required": true }, "DoNotInteractCreate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DoNotInteract" } } }, "required": true }, "DoNotInteractUpdate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DoNotInteractUpdate" } } }, "required": true }, "CaseEscalationPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseEscalation" } } }, "required": true }, "UpdateConsent": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Consents" } } }, "required": true }, "ContactBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactInformation" } } }, "required": true }, "IdentityRequest": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Identity" }, { "$ref": "#/components/schemas/CaseId" }, { "required": [ "value", "identityType" ] } ] } } }, "required": true }, "IdentityPutRequest": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdentityPut" }, { "$ref": "#/components/schemas/CaseId" } ] } } }, "required": true }, "InteractionPost": { "content": { "application/json": { "schema": { "allOf": [ { "required": [ "direction", "theme", "channel", "status" ] }, { "$ref": "#/components/schemas/Interaction" } ] } } }, "required": true }, "InteractionPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Interaction" } } }, "required": true }, "LegalRepresentative": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalRepresentative" } } }, "required": true }, "LoanPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLoan" } } }, "required": true }, "LoanUpdate": { "content": { "application/json": { "schema": { "properties": { "atOrigination": { "anyOf": [ { "$ref": "#/components/schemas/InstallmentAtOrigination" }, { "$ref": "#/components/schemas/LineOfCreditAtOrigination" } ], "description": "This object can only be updated when the loan has `status=pending`." }, "chargedOffReason": { "description": "The reason for the loan charge off. You can only update the `chargedOffReason` if the loan status is `chargedOff`.\n- `term` means the loan was charged off per loan type configuration after X days overdue.\n- `fraudulent` means the loan was charged off for fraudulent reason. If the loan is reported to one or more credit bureaus, the system will automatically send a special request to each bureau to delete the tradeline due to confirmed fraud. This is the only reason that the system will automatically trigger a request to delete the tradeline. For other reasons, if you need to delete the tradeline please call the `Delete from credit reporting` endpoint or use an agent tool.\n- `bankruptcy` means the loan was charged off because of bankruptcy.\n- `legal` means the loan was charged off because of some legal reason.\n", "enum": [ "term", "fraudulent", "bankruptcy", "legal" ], "type": "string" }, "externalId": { "description": "The lender's identifier for the loan. Requires the `loan:update.force` permission to change.", "nullable": true, "type": "string" }, "metaData": { "$ref": "#/components/schemas/MetaData" }, "migration": { "$ref": "#/components/schemas/Migration" }, "muteLoanNotices": { "description": "Indicates whether the system should stop/pause sending loan related notices to the borrower. Set to true if you want to mute all loan related notices (e.g. loanDetails. autopayEnabled, paymentFailed, etc.) Keep in mind that it will also stop all notices related to the loan that are sent from Peach Agent Portal by an agent.\nNote: this is not the only attribute that can stop notices from being sent. Compliance Guard and Cases Do Not Interact can also block communications.\n", "type": "boolean" }, "nickname": { "description": "A nickname the borrower gave the loan.", "type": "string" }, "status": { "$ref": "#/components/schemas/LoanStatus" } }, "type": "object" } } }, "required": true }, "LoanAccelerate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanAccelerate" } } }, "required": true }, "LoanActivate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanActivate" } } }, "required": false }, "AutopayPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutopayUpdate" } } }, "required": true }, "AutopayPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutopayPost" } } }, "required": true }, "LoanCancel": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanCancel" } } }, "required": true }, "CardPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardWithPanAndCvv" } } }, "required": true }, "CardPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutCardWithPanAndCvv" } } }, "required": true }, "LoanChargeOff": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanChargeOff" } } }, "required": true }, "CollectionAgencyLoanDetailsPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionAgencyLoanDetailsPut" } } }, "required": true }, "CreditReportingFieldsPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanCreditReportingFields" } } }, "required": true }, "CreditReportingStatusPost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/StartCreditReporting" }, { "required": [ "creditAgencyId", "reportingStartDate" ] } ] } } }, "required": true }, "CreditReportingStatusDelete": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeleteCreditReporting" }, { "required": [ "deletedReason" ] } ] } } }, "required": true }, "LoanCustomPaymentPlan": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanCustomPaymentPlan" } } }, "required": true }, "LoanCustomPaymentPlanCancel": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanCustomPaymentPlanCancel" } } }, "required": true }, "LoanDeferDueDate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanDeferDueDate" } } }, "required": true }, "LoanDeferSchedule": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanDeferSchedule" } } }, "required": true }, "DrawsPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draw" } } }, "required": true }, "DrawUpdate": { "content": { "application/json": { "schema": { "properties": { "atOrigination": { "$ref": "#/components/schemas/DrawAtOriginationUpdate", "description": "This object can only be updated when the draw has `status=pending`." }, "drawType": { "description": "Describes the type of line of credit purchases associated with the draw. Typically used in credit card use cases\nin which lenders set up draws specifically to be used for cash advances, balance transfers, etc.\n\n`cashAdvance` - must be set in order for Peach's system to automatically associate ATM withdrawal and other\n cash-specific transactions with a specific draw. See Create card issuer endpoint and `drawMapping` attribute for additional configuration details.\n\n`balanceTransfer` - enables lenders to create a draw that will house balance transfer transactions.\n\n`regularPurchase` - enables lenders to create a draw used for day-to-day purchases. If this attribute is set,\n Peach's system will automatically associate purchases with this draw based on the card issuer `drawMapping` logic.\n", "enum": [ "balanceTransfer", "cashAdvance", "regularPurchase" ], "nullable": true, "type": "string" }, "externalId": { "description": "The lender's identifier for the draw. Requires the `loan:update.force` permission to change.", "nullable": true, "type": "string" }, "nickname": { "description": "A nickname the borrower gave the draw.", "type": "string" }, "status": { "$ref": "#/components/schemas/LoanStatus" } }, "type": "object" } } }, "required": true }, "PromoProgramPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromoProgramPost" } } }, "required": true }, "PromoProgramPutDraw": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromoProgramPutCommon" } } }, "required": true }, "PurchaseDisputePost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PurchaseDispute" }, { "properties": { "createDisputeCase": { "default": true, "description": "If `true`, the system will automatically create a `Purchase Dispute` case object and return the case identifier in `caseId` attribute. Alternatively, you can create the case object, pass `createDisputeCase=false` and the case identifier in the `caseId` attribute.\n", "type": "boolean" } }, "type": "object" }, { "required": [ "disputedAmount" ] } ] } } }, "required": true }, "PurchaseDisputePut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseDispute" } } }, "required": true }, "RateCapAdd": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateCapAdd" } } }, "required": true }, "RateCapUpdate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateCapUpdate" } } }, "required": true }, "LoanRateAdd": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "interestRate": { "allOf": [ { "$ref": "#/components/schemas/InterestRate" }, { "$ref": "#/components/schemas/isEndExistingRatesFlag" } ] }, "promoRate": { "allOf": [ { "$ref": "#/components/schemas/PromoRate" }, { "$ref": "#/components/schemas/isEndExistingRatesFlag" } ] } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ] } } }, "required": true }, "LoanRateUpdate": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "interestRate": { "$ref": "#/components/schemas/InterestRate" }, "promoRate": { "$ref": "#/components/schemas/PromoRate" } }, "type": "object" }, { "$ref": "#/components/schemas/CaseId" } ] } } }, "required": true }, "DueDatesPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DueDatesRequest" } } }, "required": true }, "FeesPost": { "content": { "application/json": { "schema": { "properties": { "apiName": { "$ref": "#/components/schemas/FeeApiName" }, "caseId": { "description": "An identifier for an existing case.", "type": "string" }, "chargeDate": { "$ref": "#/components/schemas/ChargeDate" }, "chargeTimeOfDay": { "allOf": [ { "$ref": "#/components/schemas/TimeOfDay" }, { "description": "See description of the `chargeDate`. The value can be provided only if the `chargeDate` attribute is passed. If `chargeTimeOfDay` is not provided,\nthe Peach system will determine and set the time of day.\n", "type": "object" } ] }, "customDisplayName": { "description": "A custom description of the fee. If provided, this value will be displayed in Peach UI/App and Statements\n(or can be used by lender in their App). If the value is not provided, the Peach UI/App and Statements\nlogic will use displayName attribute. To remind, the displayName is populated from the fee type configuration object.\n", "nullable": true, "type": "string" }, "externalId": { "description": "The lender's identifier for the fee.", "type": "string" }, "feeAmount": { "description": "The fee amount, which is required only if the fee type was configured as `chargedLogic=adHoc` and `amountLogic=adHoc`. In all other\ncases, the system will calculate the fee based on pre-configured logic.\n", "type": "number" }, "migration": { "$ref": "#/components/schemas/FeesMigrationDetails", "nullable": true }, "previewMode": { "description": "In `previewMode=true`, the fee is computed but not charged.", "type": "boolean" }, "triggerPeriodId": { "description": "The ID of the period that \"triggered\" the fee. For example, if a loan is late by 5 periods, which period is this particular late fee for?\n", "type": "string" } }, "type": "object" } } }, "required": true }, "LoanChangeLoanTermsSCRAUpdate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanChangeLoanTermsSCRAUpdate" } } }, "required": true }, "LoanChangeLoanTermsSCRA": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanChangeLoanTermsSCRA" } } }, "required": true }, "LoanChangeLoanTerms": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanChangeLoanTerms" } } }, "required": true }, "PromiseToPayPlanPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromiseToPayPlanPost" } } }, "description": "Promise to pay plan post" }, "PromiseToPayPlanCancel": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromiseToPayPlanCancel" } } }, "description": "Promise to pay plan cancel" }, "PromoProgramPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromoProgramPut" } } }, "required": true }, "LoanRefund": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanRefund" } } }, "required": true }, "LoanRefundV2": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanRefundV2" } } }, "required": true }, "LoanRefundCancel": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanRefundCancel" } } }, "required": true }, "LoanReimburse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanReimburse" } } }, "required": true }, "CaseId": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseId" } } }, "required": true }, "FailMultipleTransactions": { "content": { "application/json": { "schema": { "items": { "properties": { "achReturnCode": { "description": "The ACH return code indicating the reason the transaction failed.", "example": "R01", "maxLength": 5, "type": "string" }, "failureReason": { "$ref": "#/components/schemas/TransactionFailureReason" }, "processorFailureDetails": { "description": "The error details returned by the payment processor. Can be any valid JSON object.", "example": { "code": "INSUFFICIENT_FUNDS" } }, "processorFailureReason": { "description": "The raw failure reason returned by the payment processor.", "example": "Insufficient Funds. Retry after 24 hours.", "type": "string" }, "transactionId": { "description": "ID of the transaction to fail.", "type": "string" } }, "required": [ "transactionId", "failureReason" ], "type": "object" }, "type": "array" } } }, "required": true }, "ChargebackPost": { "content": { "application/json": { "schema": { "properties": { "amount": { "description": "The amount of the chargeback. If a value is not provided the system would set the amount to `actualAmount` of the\ntransaction. If partial chargeback(s) were processed in the past, the caller must provide the amount, otherwise\nthe call would fail. Amount provided must be less than or equal to the `effectiveAmount` of the transaction at the\ntime of the call.\n", "format": "float", "type": "number" }, "caseId": { "description": "The identifier of an existing case.", "type": "string" }, "category": { "description": "The chargeback category as received from the payment processor.", "type": "string" }, "externalCaseNumber": { "description": "The external case number of the chargeback in the payment processor system.", "type": "string" }, "externalId": { "description": "The lender's identifer of the chargeback", "type": "string" }, "reasonCode": { "description": "The reason code as received from the payment processor.", "type": "string" }, "status": { "$ref": "#/components/schemas/ChargebackStatus" } }, "type": "object" } } } }, "ChargebackPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chargeback" } } } }, "ReversalPost": { "content": { "application/json": { "schema": { "properties": { "amount": { "description": "The amount of the reversal. For regular transactions, it may be a partial or full reversal; however, the sum of all successful reversals for the same\ntransaction may not exceed the transaction's `effectiveAmount`. If `amount` is not provided, it will default to the\n`effectiveAmount` of the original transaction.\n\nFor past transactions, only full reversals are supported.\n", "format": "float", "type": "number" }, "caseId": { "description": "The identifier of an existing case.", "type": "string" }, "externalId": { "description": "The external ID of the reversal transaction. This is separate from the `externalId` of the transaction being reversed in the request parameters.\n", "maxLength": 200, "minLength": 1, "type": "string" }, "scheduledDate": { "description": "The scheduled date of the reversal transaction. Can only be set for external transactions. If this value is provided, the `status` cannot be set\nto a status other than `scheduled`, and the system will automatically set `status=scheduled` if the field is not specified.\n", "format": "date", "type": "string" }, "status": { "description": "The status of the reversal transaction, not the original transaction. Status may only be set for external transactions. If a status is not passed,\nthe system will default the status to `scheduled`.\n\n - `scheduled` - reversal was scheduled for a future date that has not arrived yet. The reversal has not applied to a loan yet and is not included\n in the original transaction's `effectiveAmount`.\n - `initiated` - reversal was initiated and sent to a payment processor. The reversal is applied to a loan and impacts the original transaction's\n `effectiveAmount`. This status is used normally for ACH.\n - `pending` - reversal was acknowledged by the payment processor and is being processed.\n - `succeeded` - reversal was completed successfully. This status is only allowed for past transactions that were created as part of line of credit\n migration. `status=succeeded` is the only status that can be passed for past transaction reversals. Regular transaction reversals can only be set\n to `scheduled`, `initiated`, or `pending`.\n", "enum": [ "scheduled", "initiated", "pending", "succeeded" ], "type": "string" } }, "type": "object" } } }, "required": false }, "LoanUnfreeze": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanUnfreeze" } } }, "required": true }, "VerificationPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationPost" } } }, "required": false }, "VerificationAttemptPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationAttemptPost" } } }, "required": true }, "SupercasePost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Supercase" }, { "required": [ "supercaseType" ] } ] } } }, "required": true }, "SupercasePut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Supercase" } } }, "required": true }, "BulkSendRequestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSendRequestBody" } } }, "required": true }, "SupercaseDocumentList": { "content": { "application/json": { "schema": { "description": "List of document IDs.\n", "items": { "description": "A document descriptor ID.", "type": "string" }, "type": "array" } } }, "required": true }, "PopulationMemberCollectionPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PopulationMemberCollection" } } }, "required": true }, "PopulationMemberCollectionPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PopulationMemberCollection" } } }, "required": true }, "PopulationMemberCollectionCSVPut": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "required": true }, "PopulationMemberCollectionCSVPost": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "required": true }, "PopulationPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Population" } } }, "required": true }, "TeamPost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } }, "required": true }, "VerificationTypePost": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationType" } } }, "required": false }, "WebhookSubscriptionPost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WebhookSubscription" }, { "required": [ "webhookType" ] } ] } } }, "required": true }, "WebhookSubscriptionPut": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionPut" } } }, "required": true } }, "responses": { "CaseEscalationDetailedPaging": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/CaseEscalationDetailed" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "Amortize": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/AmortizationResult" } }, "type": "object" } ] } } }, "description": "Success" }, "TemporaryTokenResponse": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "exchangeToken": { "description": "A random token that may be exchanged for a real token via the `/auth/token` endpoint", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "SingletonResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingletonResponse" } } }, "description": "Success" }, "UserPermissions": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "$ref": "#/components/schemas/UserPermissions" } ] } } }, "description": "Success" }, "JWT": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthSuccess" } } }, "description": "JWT token" }, "UserInfo": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInfo" } } }, "description": "Success" }, "BulkSenderList": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/BulkSender" }, "type": "array" } }, "type": "object" } ] } } }, "description": "success" }, "BulkSender": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/BulkSender" } }, "type": "object" } ] } } }, "description": "success" }, "ContactExporterList": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/ContactExporter" }, "type": "array" } }, "type": "object" } ] } } }, "description": "success" }, "ContactExporter": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/ContactExporter" } }, "type": "object" } ] } } }, "description": "success" }, "BorrowerCampaignList": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/BorrowerCampaignFull" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "BorrowerCampaign": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/BorrowerCampaignFull" } }, "type": "object" } ] } } }, "description": "Success" }, "BorrowerCampaignRun": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BorrowerCampaignRun" } } }, "description": "Success" }, "CardIssuerPagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/CardIssuer" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "CardIssuerResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/CardIssuer" } }, "type": "object" } ] } } }, "description": "Success" }, "CaseTypesPaging": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/CaseType" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "CaseType": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/CaseType" } }, "type": "object" } ] } } }, "description": "Success" }, "NoContent": { "description": "Success no content" }, "SmartReviewsTasksCreated": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "caseTypeId": { "description": "Case type this task creation run was performed on", "type": "string" }, "completedAt": { "format": "date-time", "type": "string" }, "createdTasks": { "properties": { "count": { "description": "Number of reminder tasks created", "type": "number" }, "taskLog": { "additionalProperties": { "example": { "CE-XXXX-XXXX": { "caseValue": "2023-07-31T19:07:00Z", "creatingRule": "keyDates.importantDate" } }, "properties": { "caseValue": { "description": "The value on the case that triggered task creation" }, "creatingRule": { "description": "The smart reviews rule that triggered task creation", "type": "string" } }, "type": "object" }, "type": "object" } }, "type": "object" }, "smartReviewsConfig": { "description": "Smart reviews configuration for the case type as of the\ntask creation run\n", "type": "object" } }, "type": "object" } }, "type": "object" } } }, "description": "Run successful with created reminder tasks" }, "CasesPaging": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Case" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "CollectionAgencyPagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/CollectionAgency" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "CollectionAgencyResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/CollectionAgency" } }, "type": "object" } ] } } }, "description": "Success" }, "CreditAgencyPagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/CreditAgency" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "CreditAgencyResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/CreditAgency" } }, "type": "object" } ] } } }, "description": "Success" }, "CallSummaryResultsPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallSummaryResultsPaging" } } }, "description": "Success" }, "InteractionsManyNoPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsManyNoPaging" } } }, "description": "Success" }, "LoanLabelPagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/LoanLabel" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanLabelResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanLabel" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanIdsResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanIdsResponse" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanTapeTypePagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/TapeType" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanTapeTypeResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/TapeType" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanTapePagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/LoanTape" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanTapeResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanTape" } }, "type": "object" } ] } } }, "description": "Success" }, "PromiseToPayPlan": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/PromiseToPayPlan" } }, "type": "object" } ] } } }, "description": "Promise to pay plan" }, "MerchantPagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "$ref": "#/components/schemas/Merchant" } }, "type": "object" } ] } } }, "description": "Success" }, "MerchantResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Merchant" } }, "type": "object" } ] } } }, "description": "Success" }, "PromoProgramTypePaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromoProgramTypePaging" } } }, "description": "Success" }, "PromoProgramType": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/PromoProgramTypeFields" } }, "type": "object" } ] } } }, "description": "Success" }, "TaskWorkerPairingConfigPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskWorkerPairingConfigPaging" } } }, "description": "Success" }, "TaskWorkerPairingConfig": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/TaskWorkerPairingConfig" } }, "type": "object" } ] } } }, "description": "Success" }, "TaskQueueData": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/TaskQueueData" }, "type": "array" } } }, "description": "Success" }, "CodeCollection": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodePaging" } } }, "description": "Codes" }, "GetCode": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Code" } }, "type": "object" } ] } } }, "description": "Code" }, "CodeExecution": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/CodeExecution" } }, "type": "object" } ] } } }, "description": "Code Execution Result" }, "DoNotInteractTypesPaging": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/DoNotInteractType" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "DoNotInteractType": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/DoNotInteractType" } }, "type": "object" } ] } } }, "description": "Success" }, "EmployeesPaging": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Employee" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "Employee": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Employee" } }, "type": "object" } ] } } }, "description": "Success" }, "EmailSignature": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/EmailSignature" } }, "type": "object" } ] } } }, "description": "Success" }, "EventsPublic": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/EventPublic" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "InteractionsPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsPaging" } } }, "description": "Success" }, "Interaction": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Interaction" } }, "type": "object" } ] } } }, "description": "Success" }, "Note": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/NoteResponse" } }, "type": "object" } ] } } }, "description": "Success" }, "200ReturnUrl": { "content": { "application/json": { "schema": { "properties": { "url": { "format": "uri", "type": "string" } }, "type": "object" } } }, "description": "If the `returnUrl` parameter is `true` then return the url rather than redirecting." }, "302DownloadRecordedContents": { "description": "Redirected to the recorded content" }, "IndexRatePaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRatePaging" } } }, "description": "Success" }, "IndexRateResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/IndexRateResult" } }, "type": "object" } ] } } }, "description": "Success" }, "NotificationTypesPaging": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/NotificationType" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "NotificationType": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/NotificationType" } }, "type": "object" } ] } } }, "description": "Success" }, "PersonPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BorrowerPaging" } } }, "description": "Success" }, "Person": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Borrower" } }, "type": "object" } ] } } }, "description": "Success" }, "PersonSearchPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchPaging" } } }, "description": "Success" }, "PersonNoIdentity": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/BorrowerNoIdentity" } }, "type": "object" } ] } } }, "description": "Success" }, "CanInteract": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/InteractionCanInteractResult" } }, "type": "object" } ] } } }, "description": "Success" }, "Case": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Case" } }, "type": "object" } ] } } }, "description": "Success" }, "DoNotInteractPaging": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/DoNotInteract" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "DoNotInteract": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/DoNotInteract" } }, "type": "object" } ] } } }, "description": "Success" }, "CaseEscalationPaging": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/CaseEscalation" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "CaseEscalationDetailed": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseEscalationDetailed" } } }, "description": "Success" }, "Consent": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentArray" } } }, "description": "Success" }, "ContactInformationPaging": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/ContactInformation" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "ContactInformation": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/ContactInformation" } }, "type": "object" } ] } } }, "description": "Success" }, "IdentityPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityPaging" } } }, "description": "Success" }, "Identity": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Identity" } }, "type": "object" } ] } } }, "description": "Success" }, "LegalRepresentativesPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalRepresentativesPaging" } } }, "description": "Success" }, "LegalRepresentative": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LegalRepresentative" } }, "type": "object" } ] } } }, "description": "Success" }, "Loan": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Loan" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanAccelerate": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanAccelerateResponse" } }, "type": "object" } ] } } }, "description": "Loan Accelerate" }, "LoanActivate": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanActivationResponse" } }, "type": "object" } ] } } }, "description": "Success" }, "Autopay": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Autopay" } }, "type": "object" } ] } } }, "description": "Success" }, "AutopayPut": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Autopay" }, { "$ref": "#/components/schemas/DeltaTerms" } ] } }, "type": "object" } ] } } }, "description": "Success" }, "AutopayPost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Autopay" }, { "$ref": "#/components/schemas/DeltaTerms" } ] } }, "type": "object" } ] } } }, "description": "Success" }, "Balances": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Balances" } }, "type": "object" } ] } } }, "description": "Success" }, "LockedResponse": { "content": { "application/json": { "schema": { "properties": { "message": { "enum": [ "Loan is locked for updates. Please try again.", "Loan is locked for updates. Please check back again in a few minutes.", "Previous purchase is processing." ], "type": "string" } }, "type": "object" } } }, "description": "Locked" }, "CardPagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Card" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "CardResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Card" } }, "type": "object" } ] } } }, "description": "Success" }, "CardResponseWithPanAndCvv": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/CardWithPanAndCvv" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanChargeOff": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanChargeOffResponse" } }, "type": "object" } ] } } }, "description": "Loan Charge Off" }, "CollectionAgencyLoanDetailsResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/CollectionAgencyLoanDetailsGet" } }, "type": "object" } ] } } }, "description": "Success" }, "CreditReportingStatusPagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "allOf": [ { "properties": { "creditReportingDetails": { "items": { "$ref": "#/components/schemas/CreditReportingStatus" }, "type": "array" } }, "type": "object" }, { "$ref": "#/components/schemas/LoanCreditReportingFields" } ] } }, "type": "object" } ] } } }, "description": "Success" }, "CreditReportingStatusResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/CreditReportingStatus" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanCustomPaymentPlans": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/CustomPaymentPlanResult" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanCustomPaymentPlan": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/CustomPaymentPlanResult" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanDeferDueDate": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/LoanSchedule" }, { "$ref": "#/components/schemas/DueDateDeferralFeeAmount" }, { "$ref": "#/components/schemas/DeltaTerms", "description": "If deferred due date is in the past, this will be `null`, otherwise will be present.\n" }, { "properties": { "isLocked": { "description": "If true, the loan is in the middle of being updated or replayed. The returned data are not consistent. The caller should poll\non the `Get loan lock status` endpoint. Once `isLocked` becomes `false`, the caller should call GET /expected-payments again to get consistent data.\n", "type": "boolean" } }, "type": "object" } ] } }, "type": "object" } ] } } }, "description": "Success" }, "LoanDeferSchedule": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/LoanSchedule" }, { "$ref": "#/components/schemas/DueDateDeferralFeeAmount" }, { "$ref": "#/components/schemas/DeltaTerms" } ] } }, "type": "object" } ] } } }, "description": "Success" }, "PurchaseDisputePagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/PurchaseDispute" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "DrawsPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrawsPaging" } } }, "description": "Success" }, "Draw": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/DrawResponse" } }, "type": "object" } ] } } }, "description": "Success" }, "DrawActivate": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/DrawActivationResponse" } }, "type": "object" } ] } } }, "description": "Success" }, "DynamicFeesAtOrigination": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/AtOriginationDynamicFees" } }, "type": "object" } ] } } }, "description": "Success" }, "LoanEffectiveRatesResponse": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "effectiveRates": { "items": { "properties": { "effectiveDate": { "description": "The effective date.", "format": "date", "type": "string" }, "effectiveInterestRate": { "description": "The annual effective interest rate on the `effectiveDate`.\n\nFor `interestType=spread` the value is calculated as: `interestRate + indexRate - promoRate`. \nFor `interestType=absolute` the value is calculated as: `interestRate - promoRate`. \n \nAdditionally, the value cannot be negative, and cannot be higher than the lowest rate cap for the given date.\n", "format": "float", "type": "number" }, "indexRate": { "description": "The annual interest index rate value for the `effectiveDate`. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate.\n", "format": "float", "type": "number" }, "indexRateId": { "description": "The identifier of the index rate that is effective on this date.\n", "nullable": true, "type": "string" }, "interestRate": { "description": "The annual net interest rate on the `effectiveDate`. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate.\nIf two or more interest rates are `active` on the same date (aka overlap), Peach system selects the lowest rate (also called effective rate) to accrue interest.\n", "format": "float", "type": "number" }, "interestRateId": { "description": "The identifier of the interest rate that is effective on this date.", "type": "string" }, "interestType": { "description": "The interest type. The interest type cannot be changed after the loan status changes to `originated` and onward. Interest rates defined as `spread` will calculate an absolute rate by adding the relative loan rate (aka spread) provided here to the Index Interest Rate effective on the date the interest is accrued. In case the Index Interest Rate is not set, the system will assume that the Index Interest Rate value is zero on the date the interest is accrued.\n\nInterest rates defined as `absolute` will use the value as provided here without adding the Index Interest Rate.\n", "enum": [ "absolute", "spread" ], "type": "string" }, "promoRate": { "description": "The annual promo rate on the `effectiveDate`. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate.\nIf two or more promo rates are `active` on the same date (aka overlap), Peach system sums up the rates as \"effective\" promo rate.\n", "format": "float", "type": "number" }, "promoRateIds": { "description": "The identifiers of the promo rates that are effective on this date. \n(If two or more promo rates are `active` on the same date, the\nsystem sums the rates up to an \"effective\" promo rate.)\n", "items": { "type": "string" }, "type": "array" }, "rateCap": { "description": "The rate cap value that was applied to limit the effective interest rate.\nThis field contains the actual rate cap value (as a decimal, e.g., 0.36 for 36%).\n", "format": "float", "nullable": true, "type": "number" }, "rateCapIds": { "description": "The public identifiers of the rate caps that are in effect on this date.\n(If two or more rate caps are `active` on the same date, the\nsystem uses the lowest rate cap.)\n", "items": { "pattern": "^RC-[A-Z0-9]{4}-[A-Z0-9]{4}$", "type": "string" }, "type": "array" } }, "title": "effective rate", "type": "object" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "ExpectedPayments": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "$ref": "#/components/schemas/ExpectedPaymentsResult" } }, "type": "object" } ] } } }, "description": "Success" }, "FutureBalances": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/FutureBalances" } }, "type": "object" } ] } } }, "description": "Success" }, "Obligations": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/ObligationsResult" } }, "type": "object" } ] } } }, "description": "Success" }, "Obligation": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ObligationResult" }, { "$ref": "#/components/schemas/IsLocked" } ] } }, "type": "object" } ] } } }, "description": "Success" }, "PromoProgram": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/PromoProgramResult" } }, "type": "object" } ] } } }, "description": "Success" }, "PromoProgramDelete": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/PromoProgramDeleteResult" } }, "type": "object" } ] } } }, "description": "Success" }, "PurchaseDisputeResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/PurchaseDispute" } }, "type": "object" } ] } } }, "description": "Success" }, "RateCapsArray": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RateCap" }, "type": "array" } } }, "description": "Success" }, "DrawNotFound": { "description": "Loan or draw not found" }, "RateCap": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/RateCap" } }, "type": "object" } ] } } }, "description": "Success" }, "BadRequest": { "description": "Bad request - validation error" }, "DrawRateCapNotFound": { "description": "Loan, draw, or rate cap not found" }, "RateCapDeleted": { "content": { "application/json": { "schema": { "properties": { "message": { "example": "Rate cap deleted successfully", "type": "string" } }, "type": "object" } } }, "description": "Success" }, "LoanRatesResponse": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "interestRates": { "items": { "$ref": "#/components/schemas/InterestRateResponse" }, "type": "array" }, "promoRates": { "items": { "$ref": "#/components/schemas/PromoRate" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "CreateOrUpdateInterestRatesResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "properties": { "ratesValidation": { "$ref": "#/components/schemas/InterestRateValidationAfterOrig" } }, "type": "object" } }, "type": "object" } ] } } }, "description": "Success" }, "ChangeSchedule": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExpectedPaymentsResult" }, { "$ref": "#/components/schemas/DeltaTerms" } ] } }, "type": "object" } ] } } }, "description": "Success" }, "FeeNotCharged": { "content": { "application/json": { "schema": { "properties": { "message": { "description": "The reason that the fee could not be charged.", "type": "string" } }, "type": "object" } } }, "description": "Fee not charged" }, "Interest": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "properties": { "deferredInterestAccruedAmount": { "description": "The total deferred interest amount accrued between two dates. If the deferred interest promotion is exercised, the deferred interest \nis not expected to be paid. \n", "format": "float", "type": "number" }, "foregoneInterestCapAmount": { "description": "The amount of foregone interest that exceeded the interest cap amount. This is only applicable to installment loans with\n`totalInterestCapAmount=\"true\"` set atOrigination.\n", "format": "float", "type": "number" }, "interestAccruedAmount": { "description": "The total interest amount accrued between two dates.", "format": "float", "type": "number" }, "interestDiscountAmount": { "description": "The amount of the interest discount between two dates resulting from discounts, promotions, or other adjustments.", "format": "float", "type": "number" }, "netInterestAccruedAmount": { "description": "The net interest amount accrued between two dates, including adjustments for discounts and promotions.", "format": "float", "type": "number" } }, "type": "object" } }, "type": "object" } ] } } }, "description": "Success" }, "ChangeScheduleSCRA": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExpectedPaymentsResult" } ] } }, "type": "object" } ] } } }, "description": "Success" }, "LOCObligations": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LOCObligationsResult" } }, "type": "object" } ] } } }, "description": "Success" }, "LOCObligation": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/LOCObligationResult" }, { "$ref": "#/components/schemas/IsLocked" } ] } }, "type": "object" } ] } } }, "description": "Success" }, "LoanPeriodsResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanPeriodsPaging" } } }, "description": "Loan Periods" }, "LoanPeriodResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanPeriod" } }, "type": "object" } ] } } }, "description": "Loan Period" }, "PromisetoPayPlansPaging": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/PromiseToPayPlan" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "PromoProgramPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromoProgramPaging" } } }, "description": "Success" }, "PurchasesPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchasesPaging" } } }, "description": "Success" }, "LoanNotFound": { "description": "Loan not found" }, "RateCapNotFound": { "description": "Loan or rate cap not found" }, "LoanRefundCollection": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanRefundCollectionResponse" } }, "type": "object" } ] } } }, "description": "Loan Refund" }, "LoanRefundPost": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanRefund" } }, "type": "object" } ] } } }, "description": "Loan Refund" }, "LoanRefundV2Post": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanRefundV2" } }, "type": "object" } ] } } }, "description": "Loan Refund" }, "LoanReverseAccelerate": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanReverseAccelerateResponse" } }, "type": "object" } ] } } }, "description": "Loan Reverse Accelerate" }, "LoanReverseChargeOff": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanReverseChargeOffResponse" } }, "type": "object" } ] } } }, "description": "Loan Reverse Charge Off" }, "LoanScheduleOptions": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/LoanScheduleOptions" } }, "type": "object" } ] } } }, "description": "Loan Schedule Options Get" }, "StatementCollection": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatementsPaging" } } }, "description": "Collection of statements" }, "Statement": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/schemas-Statement" } }, "type": "object" } ] } } }, "description": "A single Statement" }, "StatementDetails": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/StatementDetails" } }, "type": "object" } ] } } }, "description": "Details for a single statement" }, "TransactionCollection": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionsPaging" } } }, "description": "Collection of Transactions" }, "FailMultipleTransactions": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingletonResponse" } } }, "description": "Succeeded" }, "Chargebacks": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Chargeback" }, "type": "array" } }, "type": "object" } } }, "description": "Chargebacks" }, "Chargeback": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Chargeback" } }, "type": "object" } ] } } }, "description": "Chargeback" }, "Transaction": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Transaction" } }, "type": "object" } ] } } }, "description": "A Transaction" }, "VerificationsPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationsPaging" } } }, "description": "Success" }, "Verification": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Verification" } }, "type": "object" } ] } } }, "description": "Success" }, "SupercasePagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "$ref": "#/components/schemas/SupercaseCollection" } }, "type": "object" } ] } } }, "description": "Success" }, "SupercaseResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Supercase" } }, "type": "object" } ] } } }, "description": "Success" }, "BulkOperationResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "properties": { "operationId": { "description": "The ID of the newly created bulk operation object", "type": "string" } }, "type": "object" } }, "type": "object" } ] } } }, "description": "Accepted" }, "SupercaseDocumentsResponse": { "content": { "application/json": { "schema": { "oneOf": [ { "description": "List of document IDs to associated with the supercase.\n", "items": { "description": "A document descriptor ID.", "type": "string" }, "type": "array" }, { "description": "List of documents associated with the supercase.", "items": { "$ref": "#/components/schemas/DocumentDescriptorResponse" }, "type": "array" } ] } } }, "description": "Success" }, "PopulationPagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "$ref": "#/components/schemas/PopulationCollection" } }, "type": "object" } ] } } }, "description": "Success" }, "PopulationResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Population" } }, "type": "object" } ] } } }, "description": "Success" }, "PopulationMemberCollectionResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/PopulationMemberCollection" } }, "type": "object" } ] } } }, "description": "Success" }, "PopulationMemberCollectionCSVResponse": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } }, "text/csv": { "schema": { "format": "binary", "type": "string" } } }, "description": "Success" }, "TeamsPaging": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewPaginator" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/Team" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "Team": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/Team" } }, "type": "object" } ] } } }, "description": "Success" }, "UsersPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersPaging" } } }, "description": "Success" }, "User": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/User" } }, "type": "object" } ] } } }, "description": "Success" }, "RolesPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleCollection" } } }, "description": "Success" }, "VerificationQuestionsPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationQuestionsPaging" } } }, "description": "Success" }, "VerificationTypesPaging": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationTypesPaging" } } }, "description": "Success" }, "VerificationType": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/VerificationType" } }, "type": "object" } ] } } }, "description": "Success" }, "WebhookSubscriptionPagingResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Paging" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/WebhookSubscription" }, "type": "array" } }, "type": "object" } ] } } }, "description": "Success" }, "WebhookSubscriptionResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SingletonResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/WebhookSubscription" } }, "type": "object" } ] } } }, "description": "Success" } } }, "x-tagGroups": [ { "name": "Frontend Integration", "tags": [ "Frontend", "Frontend~~Internal" ] }, { "name": "Authentication", "tags": [ "Auth", "Auth~~Internal", "API Keys" ] }, { "name": "Borrower Management", "tags": [ "Borrowers", "Borrowers~~Internal", "Identity", "Identity~~Internal", "Contact Information", "Contact Information~~Internal", "Payment Instruments", "Consent", "Documents", "Documents~~Internal", "Legal Representation", "Verifications", "Verification Types", "Monitoring Status~~Internal", "Reassigned Numbers Database~~Internal" ] }, { "name": "Campaign Management", "tags": [ "Campaign Overview", "Campaigns", "Campaigns~~Internal", "Contact Exporters", "Contact Exporters~~Internal", "Bulk Senders", "Bulk Senders~~Internal" ] }, { "name": "Case Management", "tags": [ "Cases", "Cases~~Internal", "Case Types", "Smart Reviews", "Supercases", "Do Not Interact", "Do Not Interact Types", "Notification Types", "Notes", "Workflows", "Workflow Types", "FEMA Disaster~~Internal", "Tasks", "Task-Worker Pairing Configs", "AI Case Summarizer~~Internal" ] }, { "name": "Loans Management", "tags": [ "Loans", "Loan Types~~Internal", "Installment Advances", "Installment Refunds", "Installment Refunds~~Internal", "Line of Credit Draws", "Line of Credit Purchases", "Line of Credit Purchases~~Internal", "Line of Credit Migration", "Expected Payments", "Obligations", "Periods", "Payment Plans", "SCRA", "Promise to Pay Plans", "Fees", "Dynamic Fee Type~~Internal", "Rates", "Rate Caps", "Transactions", "Statements", "Autopay", "Balances", "Credit Reporting", "Discount Programs", "Settlements", "LoansInvestors", "Collection Agency", "Loan Collection Agencies", "Promo Programs", "Monitoring Services~~Internal", "Cards", "Loan Labels" ] }, { "name": "Communicator & Interactions", "tags": [ "Communicator", "Communicator~~Internal", "Templates", "Templates~~Internal", "System Documents & UI", "System Sent Messages", "Interactions", "Compliance Guard", "Compliance Guard~~Internal" ] }, { "name": "Promo Programs Management", "tags": [ "Promo Programs Type" ] }, { "name": "Processor Management", "tags": [ "Payment Processors", "Card Issuers", "Funding Instruments", "ACH File~~Internal" ] }, { "name": "Organization Management", "tags": [ "Employees", "Teams", "Users", "Roles", "Users~~Internal", "Roles~~Internal", "Permissions~~Internal" ] }, { "name": "Capital Markets Management", "tags": [ "Investors", "Settlement Instruments", "Loan Tape Types", "Loan Tapes" ] }, { "name": "Merchants Management", "tags": [ "Merchants" ] }, { "name": "Events and Webhooks Management", "tags": [ "Events", "Events~~Internal", "Webhooks" ] }, { "name": "Utilities", "tags": [ "Loan Amortization", "Routing Numbers", "BIN Numbers", "Index Rates", "Operations" ] }, { "name": "Credit Agencies Management", "tags": [ "Credit Agencies" ] }, { "name": "Collection Agencies Management", "tags": [ "Collection Agencies" ] }, { "name": "Errors", "tags": [ "Errors" ] } ] }