Obligations

This object represents information on the borrower's obligation for a given loan period. It also provides information on the current status of the fulfillment of the obligation vis-à-vis the amount due and the due date. The obligation is dynamically changing as a result of factors such as payments and service credits made, and the crossing over of due dates.

Get loan obligations

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

query Parameters

periodId	string Use this to limit results to a specific periodId.
status	string Use this to filter a search for obligations that are `unfulfilled` or `overdue`. Enum: "unfulfilled" "overdue"

Responses

200

Success

get/people/{personId}/loans/{loanId}/obligations

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"isLocked": true,
"isOverdue": true,
"overdueAmount": 0,
"daysOverdue": 0,
"obligations": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"obligationAmount": 0,
"fulfilledAmount": 0,
"remainingAmount": 0,
"paymentsAmount": 0,
"capitalizedAmount": 0,
"serviceCreditsAmount": 0,
"overpaymentsAmount": 0,
"unassignedAmount": 0,
"isFulfilled": true,
"isOverdue": true,
"isOpen": true,
"gracePeriod": {"fullBalanceAmount": 0,
"fullBalanceMinusOverdueAmount": 0,
"totalFulfilledOnDueDateAmount": 0,
"isGracePeriodEligible": true
}
}
]
}
}

Get draw obligations

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.
drawId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ The draw identifier.

query Parameters

periodId	string Use this to limit results to a specific periodId.
status	string Use this to filter a search for obligations that are `unfulfilled` or `overdue`. Enum: "unfulfilled" "overdue"

Responses

200

Success

get/people/{personId}/loans/{loanId}/draws/{drawId}/obligations

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"isLocked": true,
"isOverdue": true,
"overdueAmount": 0,
"daysOverdue": 0,
"obligations": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"obligationAmount": 0,
"fulfilledAmount": 0,
"remainingAmount": 0,
"paymentsAmount": 0,
"capitalizedAmount": 0,
"serviceCreditsAmount": 0,
"overpaymentsAmount": 0,
"unassignedAmount": 0,
"isFulfilled": true,
"isOverdue": true,
"isOpen": true,
"gracePeriod": {"fullBalanceAmount": 0,
"fullBalanceMinusOverdueAmount": 0,
"totalFulfilledOnDueDateAmount": 0,
"isGracePeriodEligible": true
}
}
]
}
}

Get loan obligation by ID

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.
obligationId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ The obligation object unique identifier.

Responses

200

Success

get/people/{personId}/loans/{loanId}/obligations/{obligationId}

Response samples

application/json

{"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",
"obligationAmount": 0,
"fulfilledAmount": 0,
"remainingAmount": 0,
"paymentsAmount": 0,
"capitalizedAmount": 0,
"serviceCreditsAmount": 0,
"overpaymentsAmount": 0,
"unassignedAmount": 0,
"isFulfilled": true,
"isOverdue": true,
"isOpen": true,
"gracePeriod": {"fullBalanceAmount": 0,
"fullBalanceMinusOverdueAmount": 0,
"totalFulfilledOnDueDateAmount": 0,
"isGracePeriodEligible": true
},
"isLocked": true
}
}

Get draw obligation by ID

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.
drawId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ The draw identifier.
obligationId required	string^ext-\|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+\|^\d+$ The obligation object unique identifier.

Responses

200

Success

get/people/{personId}/loans/{loanId}/draws/{drawId}/obligations/{obligationId}

Response samples

application/json

{"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",
"obligationAmount": 0,
"fulfilledAmount": 0,
"remainingAmount": 0,
"paymentsAmount": 0,
"capitalizedAmount": 0,
"serviceCreditsAmount": 0,
"overpaymentsAmount": 0,
"unassignedAmount": 0,
"isFulfilled": true,
"isOverdue": true,
"isOpen": true,
"gracePeriod": {"fullBalanceAmount": 0,
"fullBalanceMinusOverdueAmount": 0,
"totalFulfilledOnDueDateAmount": 0,
"isGracePeriodEligible": true
},
"isLocked": true
}
}

➔ Next to Fees