Endpoint Description
POST Action Request - Agreement Adjustment Adjust the finance amount of a specified agreement mid term. The finance amount can be adjusted up or down.
POST Action Request - Cancel Agreement Cancels the specified agreement resource.
POST Action Request - DirectDebitMandate Refresh Refresh a direct debit mandate of a specified agreement.
POST Action Request - Hold Agreement Put the specified agreement resource on hold.
POST Action Request - Renew Agreement Renew a specified agreement.
GET Agreement Charges Agreement charges.
PUT Agreement Collection Bank Details - Replace Change the collection bank details of the specified agreement resource. This method should be used when changing the bank account details for the collection, requiring a new mandate be set up. Use the PATCH method on the Collection Details endpoint if only a change on the Preferred Payment Day is required.
GET Agreement Collection Details Returns information pertaining to the method of payment collection for the specified agreement resource. This includes bank account and bank account holder details, details of any third party payer relationship and preferred payment day.
PATCH Agreement Collection Details - Update To update one or more fields (eg. the preferred day of the month that a payment collection should be attempted) of a selected agreement resource.
GET Agreement Contact Returns a contact for a specified contact reference on an agreement.
PATCH Agreement Contact - Update Update an individual or organisation contact element of a contact-reference to correct/change a detail on a specific contact for the specified agreement resource (e.g. date of birth).
POST Agreement Contact Address - Add Change the current address of a selected contact.
PATCH Agreement Contact Address - Update Correct an existing address for a contact on a specified agreement resource.
GET Agreement Contact Current Addresses Returns a list of current addresses for the specified agreement contact.
PUT Agreement Contact Email - Add/Replace Add or replace an email address for a specific contact on a specified agreement resource.
GET Agreement Contact Emails Returns a list of email addresses for the specified agreement contact.
PUT Agreement Contact Phone - Add/Replace Add or replace a phone number for a specific contact on a specified agreement resource.
GET Agreement Contact Phones Returns a list of phone numbers for the specified agreement contact.
GET Agreement Contact Reference Using a unique Contact Reference ID, it returns a Contact Reference and allocated Role(s) for a specified agreement resource.
GET Agreement Details Returns key agreement information for the specified agreement resource.
PATCH Agreement Details - Update To update one or more Primary Fields (eg. Client Reference) of a selected agreement resource.
GET Agreement Diary Returns a list of all diary entries associated with the specified agreement resource.
GET Agreement Financial Transactions Returns a list of all financial transactions for the specified agreement resource.
GET Agreement Payments Returns a list of all payments attempted, made or collected against the specified agreement resource.
GET Agreement With Details Returns key agreement details information for the specified agreement resource.
GET AgreementCollectionSchedule Returns the collection schedule for an agreement.
GET AgreementFinancials Returns the financial information of an agreement.
GET AgreementFunding Retrieve agreement funding information.
GET AgreementProviderPurchasedProducts Returns provider purchased products information for an agreement.
GET CreditAgreementResponse Get the credit information for an agreement.
GET Direct Debit Mandate Status Returns the status of the Direct Debit mandate of an agreement.
GET Early Settlement Values Returns the early settlement values of an agreement.
GET List Agreement Contacts Returns a list of contact reference resources directly associated with the specified agreement resource or contacts indirectly related due to their role within an associated organisation.
GET List Agreements Returns a list of primary header information for agreements that match a set of passed criteria for predefined list types. List types include Agreements in Default, Cancelled Agreements, Agreements due for Renewal and Search by Field and Cumulative Business.
POST Quote Agreement Adjustment Returns a generated quote for a finance adjustment on a specified agreement mid term.