| POST Action Request - Agreement Adjustment - scheme route |
Adjust the finance amount of a specified agreement mid term. The finance amount can be adjusted up or down. |
| POST Action Request - Cancel Agreement - scheme route |
Cancels the specified agreement resource. |
| POST Action Request - Hold Agreement - scheme route |
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 - scheme route |
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 - scheme route |
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 - scheme route |
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 - scheme route |
Returns a contact for a specified contact reference on an agreement. |
| PATCH Agreement Contact - Update - scheme route |
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 - scheme route |
Change the current address of a selected contact. |
| PATCH Agreement Contact Address - Update - scheme route |
Correct an existing address for a contact on a specified agreement resource. |
| GET Agreement Contact Current Addresses - scheme route |
Returns a list of current addresses for the specified agreement contact. |
| PUT Agreement Contact Email - Add/Replace - scheme route |
Add or replace an email address for a specific contact on a specified agreement resource. |
| GET Agreement Contact Emails - scheme route |
Returns a list of email addresses for the specified agreement contact. |
| PUT Agreement Contact Phone - Add/Replace - scheme route |
Add or replace a phone number for a specific contact on a specified agreement resource. |
| GET Agreement Contact Phones - scheme route |
Returns a list of phone numbers for the specified agreement contact. |
| GET Agreement Contact Reference - scheme route |
Using a unique Contact Reference ID, it returns a Contact Reference and allocated Role(s) for a specified agreement resource. |
| GET Agreement Diary - scheme route |
Returns a list of all diary entries associated with the specified agreement resource. |
| GET Agreement Financial Transactions - scheme route |
Returns a list of all financial transactions for the specified agreement resource. |
| PATCH Agreement Header - Update - scheme route |
To update one or more primary fields (eg. Client Reference) of a selected agreement resource. |
| GET Agreement Payments - scheme route |
Returns a list of all payments attempted, made or collected against the specified agreement resource. |
| GET Agreement Primary Header - scheme route |
Retrieves basic agreement details. |
| 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 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. |
| POST Quote Agreement Adjustment |
Returns a generated quote for a finance adjustment on a specified agreement mid term. |