Developer Portal
Agreement Management
With RESTful-like APIs, the Agreement Management product gives you full control over the creation and management of PCL loan agreements.
Agreement Management allows you to:
Create a loan application
Request changes to the base agreement such as renewals and cancellations
Request quotations for mid term adjustments (MTAs) and renewals before they are submitted
You can request changes to financial and non-financial information such as addresses, email addresses, contact numbers, change of collection date, replacement agreement and bank details
Request current and historic data about an agreement
Agreement Management APIs
Agreement Applications API V3.0
Authentication API
The Authentication API allows you to request authentication tokens for your application. All API Gateway resources are accessed via HTTP requests that must contain a valid Client Access Token. Once your API product subscription has been approved, you will be provided with credentials required to obtain your Client Access Tokens, using the Authentication API.
Agreement Applications API V3.0
Agreement Applications host the API call for a new loan application.
You can view example Agreement Application payloads in the Agreement Application examples page. Note: You will only have access to this page once you have signed the PCL NDA
Agreements API V3.0
The Agreements API is used to retrieve different types of agreement details. You can:
Create a renewal loan agreement
Process the cancellation of an agreement
Request to hold an agreement
Request to re-instate a Direct Debit mandate
Retrieve customer agreement details
Change an address
Make mid term adjustments (MTAs) - quote and submission
Update contact details
Request current and historic transaction details related to an agreement
This is similar to the Scheme Agreements API which uses a scheme code and client reference.
Quotations API
The Quotations API allows you to request quotations of transactions before they are submitted. A producer can provide their customer with an exact point in time evaluation of the cost of finance.
Referenced Quotations API V3.0
The Quotations API allows you to request quotations of transactions before they are submitted. A producer can provide their customer with an exact point in time evaluation of the cost of finance.
Scheme Agreements API V3.0
The Scheme Agreements API is used to retrieve different types of agreement details. The details are retrieved using a scheme code and client reference. The Scheme Agreements API allows you to:
Create a renewal loan agreement
Process the cancellation of an agreement
Request to hold an agreement
Request to re-instate a Direct Debit mandate
Retrieve customer agreement details
Change an address
Make mid term adjustments (MTAs) - quote and submission
Update contact details
Request current and historic transaction details related to an agreement
This is similar to the Agreements API which uses an agreement route i.e. the 'C' or 'D' agreement number.
Transaction Requests API V3.0
The Transaction Requests API provides a series of transaction-related capabilities. Transactions can be requested in the form of all transactions for an existing agreement. You can also request more detailed information about a specific transaction.
