Creates past periods in preparation for migration.
required | Array of objects (PastPeriodWithRequireds) |
Success
{- "pastPeriods": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "statementDate": "2019-08-24",
- "dueDate": "2019-08-24",
- "gracePeriod": {
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0,
- "totalFulfilledOnDueDateAmount": 0,
- "isGracePeriodEligible": true
}, - "statement": {
- "documentDescriptorId": "string",
- "minimumAmountDue": 0,
- "newBalanceAmount": 0
}
}
]
}
{- "status": 0,
- "message": "string",
- "data": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "statementDate": "2019-08-24",
- "dueDate": "2019-08-24",
- "gracePeriod": {
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0,
- "totalFulfilledOnDueDateAmount": 0,
- "isGracePeriodEligible": true
}, - "statement": {
- "documentDescriptorId": "string",
- "minimumAmountDue": 0,
- "newBalanceAmount": 0
}
}
]
}
Updates past period in preparation for migration.
Success
{- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "statementDate": "2019-08-24",
- "dueDate": "2019-08-24",
- "gracePeriod": {
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0,
- "totalFulfilledOnDueDateAmount": 0,
- "isGracePeriodEligible": true
}, - "statement": {
- "documentDescriptorId": "string",
- "minimumAmountDue": 0,
- "newBalanceAmount": 0
}
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "statementDate": "2019-08-24",
- "dueDate": "2019-08-24",
- "gracePeriod": {
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0,
- "totalFulfilledOnDueDateAmount": 0,
- "isGracePeriodEligible": true
}, - "statement": {
- "documentDescriptorId": "string",
- "minimumAmountDue": 0,
- "newBalanceAmount": 0
}
}
}
Deletes past period in preparation for migration.
Success no content
Get past period in preparation for migration.
Past period data
{- "status": 0,
- "total": 0,
- "count": 0,
- "nextUrl": "string",
- "previousUrl": "string",
- "data": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "statementDate": "2019-08-24",
- "dueDate": "2019-08-24",
- "gracePeriod": {
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0,
- "totalFulfilledOnDueDateAmount": 0,
- "isGracePeriodEligible": true
}, - "statement": {
- "documentDescriptorId": "string",
- "minimumAmountDue": 0,
- "newBalanceAmount": 0
}
}
]
}
Migration period LOC data
{- "status": 0,
- "message": "string",
- "data": {
- "postMigrationLoanStatus": "active",
- "postMigrationLoanChargedOffReason": "term",
- "migrationPeriod": {
- "id": "string",
- "object": "loanPeriod",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "statementDate": "2019-08-24",
- "dueDate": "2019-08-24"
}, - "obligation": {
- "obligationAmount": 0,
- "migratedDaysOverdue": 0,
- "migratedOverdueFromDate": "2019-08-24"
}, - "gracePeriod": {
- "isGracePeriodEligible": true,
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0
}, - "balances": {
- "nonDueBalances": {
- "nonDueOriginationFeesAmount": 0,
- "nonDueLateFeesAmount": 0
}, - "dueBalances": {
- "dueOriginationFeesAmount": 0,
- "dueLateFeesAmount": 0
}, - "overdueBalances": {
- "overdueOriginationFeesAmount": 0,
- "overdueLateFeesAmount": 0
}, - "creditLimitAmount": 0,
- "reimbursementAmount": 0
}, - "migratedOverdueAmount": 0
}
}
Migration period LOC data
{- "postMigrationLoanStatus": "active",
- "postMigrationLoanChargedOffReason": "term",
- "migrationPeriod": {
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "statementDate": "2019-08-24",
- "dueDate": "2019-08-24"
}, - "obligation": {
- "obligationAmount": 0,
- "migratedDaysOverdue": 0,
- "migratedOverdueFromDate": "2019-08-24"
}, - "gracePeriod": {
- "isGracePeriodEligible": true,
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0
}, - "balances": {
- "nonDueBalances": {
- "nonDueOriginationFeesAmount": 0,
- "nonDueLateFeesAmount": 0
}, - "dueBalances": {
- "dueOriginationFeesAmount": 0,
- "dueLateFeesAmount": 0
}, - "overdueBalances": {
- "overdueOriginationFeesAmount": 0,
- "overdueLateFeesAmount": 0
}, - "creditLimitAmount": 0,
- "reimbursementAmount": 0
}
}
{- "status": 0,
- "message": "string",
- "data": {
- "postMigrationLoanStatus": "active",
- "postMigrationLoanChargedOffReason": "term",
- "migrationPeriod": {
- "id": "string",
- "object": "loanPeriod",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "statementDate": "2019-08-24",
- "dueDate": "2019-08-24"
}, - "obligation": {
- "obligationAmount": 0,
- "migratedDaysOverdue": 0,
- "migratedOverdueFromDate": "2019-08-24"
}, - "gracePeriod": {
- "isGracePeriodEligible": true,
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0
}, - "balances": {
- "nonDueBalances": {
- "nonDueOriginationFeesAmount": 0,
- "nonDueLateFeesAmount": 0
}, - "dueBalances": {
- "dueOriginationFeesAmount": 0,
- "dueLateFeesAmount": 0
}, - "overdueBalances": {
- "overdueOriginationFeesAmount": 0,
- "overdueLateFeesAmount": 0
}, - "creditLimitAmount": 0,
- "reimbursementAmount": 0
}, - "migratedOverdueAmount": 0
}
}
This endpoint allows you to pass additional details about the line in preparation for migration.
The "Migration period" is the period in which you execute the migration. This is the period from which the Peach system takes control over the line. This period is considered to be "open" at the time of the migration. The migration needs to be completed before the upcoming due date. To clarify, the upcoming due date corresponds to the previous period's statement date.
"Migration cutoff date" is the most recent statement date relative to the day on which you execute the migration process. This date is also the startDate
of the migration period.
"Migration at date" is the actual date on which you execute the migration.
For example:
dueDate
, Aug 22, 2024, falls in the "migration period" that starts on Aug 1, 2024 and ends on Aug 31, 2024.Migration period LOC data
{- "postMigrationLoanStatus": "active",
- "postMigrationLoanChargedOffReason": "term",
- "migrationPeriod": {
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "statementDate": "2019-08-24",
- "dueDate": "2019-08-24"
}, - "obligation": {
- "obligationAmount": 0,
- "migratedDaysOverdue": 0,
- "migratedOverdueFromDate": "2019-08-24"
}, - "gracePeriod": {
- "isGracePeriodEligible": true,
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0
}, - "balances": {
- "nonDueBalances": {
- "nonDueOriginationFeesAmount": 0,
- "nonDueLateFeesAmount": 0
}, - "dueBalances": {
- "dueOriginationFeesAmount": 0,
- "dueLateFeesAmount": 0
}, - "overdueBalances": {
- "overdueOriginationFeesAmount": 0,
- "overdueLateFeesAmount": 0
}, - "creditLimitAmount": 0,
- "reimbursementAmount": 0
}
}
{- "status": 0,
- "message": "string",
- "data": {
- "postMigrationLoanStatus": "active",
- "postMigrationLoanChargedOffReason": "term",
- "migrationPeriod": {
- "id": "string",
- "object": "loanPeriod",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "statementDate": "2019-08-24",
- "dueDate": "2019-08-24"
}, - "obligation": {
- "obligationAmount": 0,
- "migratedDaysOverdue": 0,
- "migratedOverdueFromDate": "2019-08-24"
}, - "gracePeriod": {
- "isGracePeriodEligible": true,
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0
}, - "balances": {
- "nonDueBalances": {
- "nonDueOriginationFeesAmount": 0,
- "nonDueLateFeesAmount": 0
}, - "dueBalances": {
- "dueOriginationFeesAmount": 0,
- "dueLateFeesAmount": 0
}, - "overdueBalances": {
- "overdueOriginationFeesAmount": 0,
- "overdueLateFeesAmount": 0
}, - "creditLimitAmount": 0,
- "reimbursementAmount": 0
}, - "migratedOverdueAmount": 0
}
}
Migration period draw data
{- "status": 0,
- "message": "string",
- "data": {
- "obligation": {
- "obligationAmount": 0,
- "migratedDaysOverdue": 0
}, - "gracePeriod": {
- "isGracePeriodEligible": true,
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0
}, - "balances": {
- "nonDueBalances": {
- "nonDuePrincipalAmount": 0,
- "nonDueInterestAmount": 0,
- "nonDueDrawFeesAmount": 0,
- "nonDueLateFeesAmount": 0,
- "nonDueModificationFeesAmount": 0
}, - "dueBalances": {
- "duePrincipalAmount": 0,
- "dueInterestAmount": 0,
- "dueDrawFeesAmount": 0,
- "dueLateFeesAmount": 0,
- "dueModificationFeesAmount": 0
}, - "overdueBalances": {
- "overduePrincipalAmount": 0,
- "overdueInterestAmount": 0,
- "overdueDrawFeesAmount": 0,
- "overdueLateFeesAmount": 0,
- "overdueModificationFeesAmount": 0
}, - "creditLimitAmount": 0
}, - "migratedOverdueAmount": 0
}
}
object (DrawMigrationObligation) If you are not migrating past periods and the migration period is the first period of the LOC: Don't pass the If you are migrating past periods: This is the draw level obligation details. The 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. To 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 For example:
| |
object (DrawMigrationGracePeriod) If you are not migrating past periods and the migration period is the first period of the LOC: Don't pass the If you are migrating past periods: This is the draw level grace period details. The 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. The migration period is a "live" period in which you execute migration.
For example:
| |
object (DrawMigrationBalances) 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. We expect
|
Migration period draw data
{- "obligation": {
- "obligationAmount": 0,
- "migratedDaysOverdue": 0
}, - "gracePeriod": {
- "isGracePeriodEligible": true,
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0
}, - "balances": {
- "nonDueBalances": {
- "nonDuePrincipalAmount": 0,
- "nonDueInterestAmount": 0,
- "nonDueDrawFeesAmount": 0,
- "nonDueLateFeesAmount": 0,
- "nonDueModificationFeesAmount": 0
}, - "dueBalances": {
- "duePrincipalAmount": 0,
- "dueInterestAmount": 0,
- "dueDrawFeesAmount": 0,
- "dueLateFeesAmount": 0,
- "dueModificationFeesAmount": 0
}, - "overdueBalances": {
- "overduePrincipalAmount": 0,
- "overdueInterestAmount": 0,
- "overdueDrawFeesAmount": 0,
- "overdueLateFeesAmount": 0,
- "overdueModificationFeesAmount": 0
}, - "creditLimitAmount": 0
}
}
{- "status": 0,
- "message": "string",
- "data": {
- "obligation": {
- "obligationAmount": 0,
- "migratedDaysOverdue": 0
}, - "gracePeriod": {
- "isGracePeriodEligible": true,
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0
}, - "balances": {
- "nonDueBalances": {
- "nonDuePrincipalAmount": 0,
- "nonDueInterestAmount": 0,
- "nonDueDrawFeesAmount": 0,
- "nonDueLateFeesAmount": 0,
- "nonDueModificationFeesAmount": 0
}, - "dueBalances": {
- "duePrincipalAmount": 0,
- "dueInterestAmount": 0,
- "dueDrawFeesAmount": 0,
- "dueLateFeesAmount": 0,
- "dueModificationFeesAmount": 0
}, - "overdueBalances": {
- "overduePrincipalAmount": 0,
- "overdueInterestAmount": 0,
- "overdueDrawFeesAmount": 0,
- "overdueLateFeesAmount": 0,
- "overdueModificationFeesAmount": 0
}, - "creditLimitAmount": 0
}, - "migratedOverdueAmount": 0
}
}
This endpoint allows you to pass additional details about draws in preparation for migration.
The "migration period" is the period in which you execute the migration. This is the period from which the Peach system takes control over the line. This period is considered to be "open" at the time of the migration. The migration needs to be completed before the upcoming due date. To clarify, the upcoming due date corresponds to the previous period's statement date.
The "Migration cutoff date" is the most recent statement date relative to the day on which you execute the migration process. This date is also the startDate
of the migration period.
The "Migration at date" is the actual date on which you execute the migration.
For example:
dueDate
, Aug 22, 2024, falls in the 'migration period' that starts on Aug 1, 2024 and ends on Aug 31, 2024.required | object (DrawMigrationObligation) If you are not migrating past periods and the migration period is the first period of the LOC: Don't pass the If you are migrating past periods: This is the draw level obligation details. The 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. To 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 For example:
|
required | object (DrawMigrationGracePeriod) If you are not migrating past periods and the migration period is the first period of the LOC: Don't pass the If you are migrating past periods: This is the draw level grace period details. The 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. The migration period is a "live" period in which you execute migration.
For example:
|
required | object (DrawMigrationBalances) 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. We expect
|
Migration period draw data
{- "obligation": {
- "obligationAmount": 0,
- "migratedDaysOverdue": 0
}, - "gracePeriod": {
- "isGracePeriodEligible": true,
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0
}, - "balances": {
- "nonDueBalances": {
- "nonDuePrincipalAmount": 0,
- "nonDueInterestAmount": 0,
- "nonDueDrawFeesAmount": 0,
- "nonDueLateFeesAmount": 0,
- "nonDueModificationFeesAmount": 0
}, - "dueBalances": {
- "duePrincipalAmount": 0,
- "dueInterestAmount": 0,
- "dueDrawFeesAmount": 0,
- "dueLateFeesAmount": 0,
- "dueModificationFeesAmount": 0
}, - "overdueBalances": {
- "overduePrincipalAmount": 0,
- "overdueInterestAmount": 0,
- "overdueDrawFeesAmount": 0,
- "overdueLateFeesAmount": 0,
- "overdueModificationFeesAmount": 0
}, - "creditLimitAmount": 0
}
}
{- "status": 0,
- "message": "string",
- "data": {
- "obligation": {
- "obligationAmount": 0,
- "migratedDaysOverdue": 0
}, - "gracePeriod": {
- "isGracePeriodEligible": true,
- "fullBalanceAmount": 0,
- "fullBalanceMinusOverdueAmount": 0
}, - "balances": {
- "nonDueBalances": {
- "nonDuePrincipalAmount": 0,
- "nonDueInterestAmount": 0,
- "nonDueDrawFeesAmount": 0,
- "nonDueLateFeesAmount": 0,
- "nonDueModificationFeesAmount": 0
}, - "dueBalances": {
- "duePrincipalAmount": 0,
- "dueInterestAmount": 0,
- "dueDrawFeesAmount": 0,
- "dueLateFeesAmount": 0,
- "dueModificationFeesAmount": 0
}, - "overdueBalances": {
- "overduePrincipalAmount": 0,
- "overdueInterestAmount": 0,
- "overdueDrawFeesAmount": 0,
- "overdueLateFeesAmount": 0,
- "overdueModificationFeesAmount": 0
}, - "creditLimitAmount": 0
}, - "migratedOverdueAmount": 0
}
}
Creates past transaction in preparation for line of credit migration.
Created
{- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "type": "oneTime",
- "externalId": "string",
- "failureReason": "insufficientFunds",
- "paymentInstrumentId": "string",
- "amount": 0,
- "evidenceDocumentId": "string",
- "status": "initiated",
- "effectiveDate": "2019-08-24",
- "effectiveTimeOfDay": {
- "hour": 23,
- "minute": 59,
- "second": 0
}, - "paymentInstrumentDetails": {
- "type": "bankAccount",
- "customDisplayName": "string",
- "accountLastFour": "stri"
}, - "migration": {
- "drawSplitDetails": [
- {
- "originalDrawId": "string",
- "drawAllocatedAmount": 0
}
]
}
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "status": "scheduled",
- "timestamps": {
- "effectiveDate": "2019-08-24",
- "originalEffectiveDate": "2019-08-24",
- "originalDisplayDate": "2019-08-24",
- "scheduledDate": "2019-08-24",
- "displayDate": "2019-08-24",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "initiatedAt": "2019-08-24T14:15:22Z",
- "pendingAt": "2019-08-24T14:15:22Z",
- "succeededAt": "2019-08-24T14:15:22Z",
- "failedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z",
- "inDisputeAt": "2019-08-24T14:15:22Z",
- "chargebackAt": "2019-08-24T14:15:22Z",
- "appliedAt": "2019-08-24T14:15:22Z"
}, - "transactionType": "payment",
- "paymentDetails": {
- "type": "ach",
- "reason": "autoPay",
- "fromInstrumentId": "string",
- "fromInstrument": {
- "instrumentType": "bankAccount",
- "accountNumberLastFour": "string"
}, - "toInstrumentId": "string",
- "toInstrument": {
- "instrumentType": "bankAccount",
- "accountNumberLastFour": "string"
}
}, - "actualAmount": 0,
- "scheduledAmount": 0,
- "currency": "string",
- "processingFeeAmount": 0,
- "processingFeeType": "net",
- "processorTransactionId": "string",
- "processorReversalId": "string",
- "processorReconciliationId": "string",
- "avsResult": "s",
- "failureReason": "insufficientFunds",
- "failureDescriptionShort": "string",
- "failureDescriptionLong": "string",
- "processorFailureReason": "string",
- "processorFailureDetails": null,
- "achReturnCode": "strin",
- "reversedByTransactionId": "string",
- "reversedByTransactionExternalId": "string",
- "reversedByTransactionIds": [
- {
- "id": "string",
- "externalId": "string"
}
], - "reversesTransactionId": "string",
- "reversesTransactionExternalId": "string",
- "reversedAmount": 0,
- "parentTransactionId": "string",
- "createdBy": {
- "id": "string",
- "name": "string",
- "userType": "agent",
- "descriptor": "Agent bob@acme.com",
- "employee": {
- "id": "string"
}
}, - "cancelReason": "invalidPaymentMethod",
- "holdDaysEndDate": "2019-08-24",
- "metaData": { },
- "customDisplayName": "string",
- "retryAttempt": 0,
- "processorMerchantId": "string",
- "achConfirmed": true,
- "achSameDay": true,
- "achProcessedSameDay": true,
- "cancelShortDescription": "string",
- "cancelLongDescription": "string",
- "retryOriginalTransactionId": "string",
- "isExternal": null,
- "isVirtual": null,
- "paidPrincipalAmount": null,
- "paidInterestAmount": null,
- "paidFeesAmount": null,
- "paidOverAmount": null,
- "serviceCreditDetails": {
- "type": "serviceAgent",
- "sponsor": "loanOwner",
- "reason": "oneTimePayment"
}, - "chargebackDetails": [
- {
- "id": "string",
- "externalId": "string",
- "caseId": "string",
- "status": "open",
- "amount": 0,
- "description": "string",
- "externalCaseNumber": "string",
- "reasonCode": "string",
- "category": "string"
}
], - "effectiveAmount": 0,
- "chargebackAmount": 0,
- "unroundedPaidPrincipalAmount": 0,
- "unroundedPaidInterestAmount": 0,
- "unroundedPaidFeesAmount": 0,
- "unroundedPaidOverAmount": 0,
- "initiatingBorrowerId": "string",
- "autopayPlanId": "string",
- "autopayPaymentIds": [
- 0
], - "enablePrepayments": true,
- "loanId": "string",
- "drawId": "string",
- "mainBorrowerId": "string",
- "migration": {
- "drawSplitDetails": [
- {
- "originalDrawId": "string",
- "drawAllocatedAmount": 0
}
]
}
}
}
Success
{- "status": 0,
- "total": 0,
- "count": 0,
- "nextUrl": "string",
- "previousUrl": "string",
- "data": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "status": "scheduled",
- "timestamps": {
- "effectiveDate": "2019-08-24",
- "originalEffectiveDate": "2019-08-24",
- "originalDisplayDate": "2019-08-24",
- "scheduledDate": "2019-08-24",
- "displayDate": "2019-08-24",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "initiatedAt": "2019-08-24T14:15:22Z",
- "pendingAt": "2019-08-24T14:15:22Z",
- "succeededAt": "2019-08-24T14:15:22Z",
- "failedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z",
- "inDisputeAt": "2019-08-24T14:15:22Z",
- "chargebackAt": "2019-08-24T14:15:22Z",
- "appliedAt": "2019-08-24T14:15:22Z"
}, - "transactionType": "payment",
- "paymentDetails": {
- "type": "ach",
- "reason": "autoPay",
- "fromInstrumentId": "string",
- "fromInstrument": {
- "instrumentType": "bankAccount",
- "accountNumberLastFour": "string"
}, - "toInstrumentId": "string",
- "toInstrument": {
- "instrumentType": "bankAccount",
- "accountNumberLastFour": "string"
}
}, - "actualAmount": 0,
- "scheduledAmount": 0,
- "currency": "string",
- "processingFeeAmount": 0,
- "processingFeeType": "net",
- "processorTransactionId": "string",
- "processorReversalId": "string",
- "processorReconciliationId": "string",
- "avsResult": "s",
- "failureReason": "insufficientFunds",
- "failureDescriptionShort": "string",
- "failureDescriptionLong": "string",
- "processorFailureReason": "string",
- "processorFailureDetails": null,
- "achReturnCode": "strin",
- "reversedByTransactionId": "string",
- "reversedByTransactionExternalId": "string",
- "reversedByTransactionIds": [
- {
- "id": "string",
- "externalId": "string"
}
], - "reversesTransactionId": "string",
- "reversesTransactionExternalId": "string",
- "reversedAmount": 0,
- "parentTransactionId": "string",
- "createdBy": {
- "id": "string",
- "name": "string",
- "userType": "agent",
- "descriptor": "Agent bob@acme.com",
- "employee": {
- "id": "string"
}
}, - "cancelReason": "invalidPaymentMethod",
- "holdDaysEndDate": "2019-08-24",
- "metaData": { },
- "customDisplayName": "string",
- "retryAttempt": 0,
- "processorMerchantId": "string",
- "achConfirmed": true,
- "achSameDay": true,
- "achProcessedSameDay": true,
- "cancelShortDescription": "string",
- "cancelLongDescription": "string",
- "retryOriginalTransactionId": "string",
- "isExternal": null,
- "isVirtual": null,
- "paidPrincipalAmount": null,
- "paidInterestAmount": null,
- "paidFeesAmount": null,
- "paidOverAmount": null,
- "serviceCreditDetails": {
- "type": "serviceAgent",
- "sponsor": "loanOwner",
- "reason": "oneTimePayment"
}, - "chargebackDetails": [
- {
- "id": "string",
- "externalId": "string",
- "caseId": "string",
- "status": "open",
- "amount": 0,
- "description": "string",
- "externalCaseNumber": "string",
- "reasonCode": "string",
- "category": "string"
}
], - "effectiveAmount": 0,
- "chargebackAmount": 0,
- "unroundedPaidPrincipalAmount": 0,
- "unroundedPaidInterestAmount": 0,
- "unroundedPaidFeesAmount": 0,
- "unroundedPaidOverAmount": 0,
- "initiatingBorrowerId": "string",
- "autopayPlanId": "string",
- "autopayPaymentIds": [
- 0
], - "enablePrepayments": true,
- "loanId": "string",
- "drawId": "string",
- "mainBorrowerId": "string",
- "migration": {
- "drawSplitDetails": [
- {
- "originalDrawId": "string",
- "drawAllocatedAmount": 0
}
]
}
}
]
}
Update past transaction in preparation for line of credit migration.
Note: After migration, you should call the "Update transaction" endpoint.
Success
{- "effectiveDate": "2019-08-24",
- "effectiveTimeOfDay": {
- "hour": 23,
- "minute": 59,
- "second": 0
}, - "paymentInstrumentDetails": {
- "type": "bankAccount",
- "customDisplayName": "string",
- "accountLastFour": "stri"
}, - "migration": {
- "drawSplitDetails": [
- {
- "originalDrawId": "string",
- "drawAllocatedAmount": 0
}
]
}, - "externalId": "string",
- "amount": 0,
- "status": "initiated",
- "failureReason": "insufficientFunds"
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "status": "scheduled",
- "timestamps": {
- "effectiveDate": "2019-08-24",
- "originalEffectiveDate": "2019-08-24",
- "originalDisplayDate": "2019-08-24",
- "scheduledDate": "2019-08-24",
- "displayDate": "2019-08-24",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "initiatedAt": "2019-08-24T14:15:22Z",
- "pendingAt": "2019-08-24T14:15:22Z",
- "succeededAt": "2019-08-24T14:15:22Z",
- "failedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z",
- "inDisputeAt": "2019-08-24T14:15:22Z",
- "chargebackAt": "2019-08-24T14:15:22Z",
- "appliedAt": "2019-08-24T14:15:22Z"
}, - "transactionType": "payment",
- "paymentDetails": {
- "type": "ach",
- "reason": "autoPay",
- "fromInstrumentId": "string",
- "fromInstrument": {
- "instrumentType": "bankAccount",
- "accountNumberLastFour": "string"
}, - "toInstrumentId": "string",
- "toInstrument": {
- "instrumentType": "bankAccount",
- "accountNumberLastFour": "string"
}
}, - "actualAmount": 0,
- "scheduledAmount": 0,
- "currency": "string",
- "processingFeeAmount": 0,
- "processingFeeType": "net",
- "processorTransactionId": "string",
- "processorReversalId": "string",
- "processorReconciliationId": "string",
- "avsResult": "s",
- "failureReason": "insufficientFunds",
- "failureDescriptionShort": "string",
- "failureDescriptionLong": "string",
- "processorFailureReason": "string",
- "processorFailureDetails": null,
- "achReturnCode": "strin",
- "reversedByTransactionId": "string",
- "reversedByTransactionExternalId": "string",
- "reversedByTransactionIds": [
- {
- "id": "string",
- "externalId": "string"
}
], - "reversesTransactionId": "string",
- "reversesTransactionExternalId": "string",
- "reversedAmount": 0,
- "parentTransactionId": "string",
- "createdBy": {
- "id": "string",
- "name": "string",
- "userType": "agent",
- "descriptor": "Agent bob@acme.com",
- "employee": {
- "id": "string"
}
}, - "cancelReason": "invalidPaymentMethod",
- "holdDaysEndDate": "2019-08-24",
- "metaData": { },
- "customDisplayName": "string",
- "retryAttempt": 0,
- "processorMerchantId": "string",
- "achConfirmed": true,
- "achSameDay": true,
- "achProcessedSameDay": true,
- "cancelShortDescription": "string",
- "cancelLongDescription": "string",
- "retryOriginalTransactionId": "string",
- "isExternal": null,
- "isVirtual": null,
- "paidPrincipalAmount": null,
- "paidInterestAmount": null,
- "paidFeesAmount": null,
- "paidOverAmount": null,
- "serviceCreditDetails": {
- "type": "serviceAgent",
- "sponsor": "loanOwner",
- "reason": "oneTimePayment"
}, - "chargebackDetails": [
- {
- "id": "string",
- "externalId": "string",
- "caseId": "string",
- "status": "open",
- "amount": 0,
- "description": "string",
- "externalCaseNumber": "string",
- "reasonCode": "string",
- "category": "string"
}
], - "effectiveAmount": 0,
- "chargebackAmount": 0,
- "unroundedPaidPrincipalAmount": 0,
- "unroundedPaidInterestAmount": 0,
- "unroundedPaidFeesAmount": 0,
- "unroundedPaidOverAmount": 0,
- "initiatingBorrowerId": "string",
- "autopayPlanId": "string",
- "autopayPaymentIds": [
- 0
], - "enablePrepayments": true,
- "loanId": "string",
- "drawId": "string",
- "mainBorrowerId": "string",
- "migration": {
- "drawSplitDetails": [
- {
- "originalDrawId": "string",
- "drawAllocatedAmount": 0
}
]
}
}
}
Success
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "status": "scheduled",
- "timestamps": {
- "effectiveDate": "2019-08-24",
- "originalEffectiveDate": "2019-08-24",
- "originalDisplayDate": "2019-08-24",
- "scheduledDate": "2019-08-24",
- "displayDate": "2019-08-24",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "initiatedAt": "2019-08-24T14:15:22Z",
- "pendingAt": "2019-08-24T14:15:22Z",
- "succeededAt": "2019-08-24T14:15:22Z",
- "failedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z",
- "inDisputeAt": "2019-08-24T14:15:22Z",
- "chargebackAt": "2019-08-24T14:15:22Z",
- "appliedAt": "2019-08-24T14:15:22Z"
}, - "transactionType": "payment",
- "paymentDetails": {
- "type": "ach",
- "reason": "autoPay",
- "fromInstrumentId": "string",
- "fromInstrument": {
- "instrumentType": "bankAccount",
- "accountNumberLastFour": "string"
}, - "toInstrumentId": "string",
- "toInstrument": {
- "instrumentType": "bankAccount",
- "accountNumberLastFour": "string"
}
}, - "actualAmount": 0,
- "scheduledAmount": 0,
- "currency": "string",
- "processingFeeAmount": 0,
- "processingFeeType": "net",
- "processorTransactionId": "string",
- "processorReversalId": "string",
- "processorReconciliationId": "string",
- "avsResult": "s",
- "failureReason": "insufficientFunds",
- "failureDescriptionShort": "string",
- "failureDescriptionLong": "string",
- "processorFailureReason": "string",
- "processorFailureDetails": null,
- "achReturnCode": "strin",
- "reversedByTransactionId": "string",
- "reversedByTransactionExternalId": "string",
- "reversedByTransactionIds": [
- {
- "id": "string",
- "externalId": "string"
}
], - "reversesTransactionId": "string",
- "reversesTransactionExternalId": "string",
- "reversedAmount": 0,
- "parentTransactionId": "string",
- "createdBy": {
- "id": "string",
- "name": "string",
- "userType": "agent",
- "descriptor": "Agent bob@acme.com",
- "employee": {
- "id": "string"
}
}, - "cancelReason": "invalidPaymentMethod",
- "holdDaysEndDate": "2019-08-24",
- "metaData": { },
- "customDisplayName": "string",
- "retryAttempt": 0,
- "processorMerchantId": "string",
- "achConfirmed": true,
- "achSameDay": true,
- "achProcessedSameDay": true,
- "cancelShortDescription": "string",
- "cancelLongDescription": "string",
- "retryOriginalTransactionId": "string",
- "isExternal": null,
- "isVirtual": null,
- "paidPrincipalAmount": null,
- "paidInterestAmount": null,
- "paidFeesAmount": null,
- "paidOverAmount": null,
- "serviceCreditDetails": {
- "type": "serviceAgent",
- "sponsor": "loanOwner",
- "reason": "oneTimePayment"
}, - "chargebackDetails": [
- {
- "id": "string",
- "externalId": "string",
- "caseId": "string",
- "status": "open",
- "amount": 0,
- "description": "string",
- "externalCaseNumber": "string",
- "reasonCode": "string",
- "category": "string"
}
], - "effectiveAmount": 0,
- "chargebackAmount": 0,
- "unroundedPaidPrincipalAmount": 0,
- "unroundedPaidInterestAmount": 0,
- "unroundedPaidFeesAmount": 0,
- "unroundedPaidOverAmount": 0,
- "initiatingBorrowerId": "string",
- "autopayPlanId": "string",
- "autopayPaymentIds": [
- 0
], - "enablePrepayments": true,
- "loanId": "string",
- "drawId": "string",
- "mainBorrowerId": "string",
- "migration": {
- "drawSplitDetails": [
- {
- "originalDrawId": "string",
- "drawAllocatedAmount": 0
}
]
}
}
}
Request sandbox access