canonical: https://jentic.com/apis/ddcms.accesspaysuite.com/ddcms-accesspaysuite

# Ddcms Accesspaysuite Access PaySuite

The Access PaySuite API manages UK Direct Debit and BACS collection for a client: you create customers, set up recurring payment contracts, and run the schedules that collect from them. You amend a contract's amount or frequency, freeze or skip cycles, take one-off and bulk payments, and read the schedules, future schedules, and payment history for any contract. BACS callbacks and client questions round out the workflow around onboarding and collecting recurring payments.

## For AI agents

Create customers and recurring Direct Debit contracts, run and amend their payment schedules, and take one-off or bulk BACS payments through Access PaySuite. Reads schedules, future schedules, and payment history per contract.

## Scope

Does not handle card payments, invoicing, or general-ledger accounting. Use for UK Direct Debit and BACS collection through Access PaySuite only.

## Capabilities

- Create and read customers and their Direct Debit contracts under a client
- Set up and amend recurring payment schedules by frequency and amount
- Freeze, skip, cancel, restart, or reactivate a contract's collection
- Take one-off payments and submit bulk payment runs
- Read a contract's schedules, future schedules, and payment history
- Manage BACS callbacks and the client's onboarding questions

## Use cases

### Agent-Managed Direct Debit Onboarding

An AI agent onboards a new payer by creating the customer under a client, opening a Direct Debit contract, and setting a monthly schedule in one flow. The agent reads the contract's future schedules back to confirm the first collection date, so a signup assistant can set up recurring billing end to end.

Example prompt: Create a customer under the client, open a Direct Debit contract, set a monthly schedule, and return the next collection date

### Recurring Payment Adjustments

Handle mid-contract changes without manual intervention: change the collected amount, freeze a run of cycles, or skip the next payment when a payer asks. The API exposes dedicated patch actions for change-amount, freeze, and skip, so a support agent can apply the right adjustment and log it against the contract.

Example prompt: Freeze the next two collection cycles on a contract, then read its future schedules to confirm the change

### Bulk Collection Runs

Collect from many contracts at once by submitting a bulk payment run for a client, then reconcile the results against each contract's payment history. This drives scheduled billing jobs that would otherwise call the single-payment endpoint repeatedly.

Example prompt: Submit a bulk payment run for the client and then read each contract's payment history to confirm the collections

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/client/{clientCode}/customer` | List customers for a client |
| POST | `/client/{clientCode}/customer` | Create a customer |
| POST | `/client/{clientCode}/customer/{customerId}/contract` | Open a Direct Debit contract for a customer |
| POST | `/client/{clientCode}/contract/{contractId}/payment` | Take a one-off payment on a contract |
| GET | `/client/{clientCode}/contract/{contractId}/schedule` | Read a contract's schedule |
| POST | `/client/{clientCode}/contract/{contractId}/patch/freeze` | Freeze collection cycles |
| POST | `/client/{clientCode}/bulk/payments` | Submit a bulk payment run |
| GET | `/client/{clientCode}/schedules` | List schedules across the client |

## Key resources

- **Customers** — Payers created under a client, with their contracts and onboarding question answers
- **Contracts** — Recurring Direct Debit agreements with amount, frequency, and lifecycle actions
- **Schedules** — Current and future collection schedules for a contract
- **Payments** — One-off, bulk, and historical payments, plus BACS callbacks

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 38 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 42 / 100
  - Developer Experience & Jentic Compatibility: 66 / 100
  - AI-Readiness & Agent Experience: 17 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 65 / 100
- **View full report:** https://jentic.com/apis/ddcms.accesspaysuite.com/ddcms-accesspaysuite/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** By hand you provision an API key, set the apiKey header, learn the client, contract, and schedule model, and wire the patch actions for amount, freeze, and skip before collecting a payment. Through Jentic you connect once from the API Directory and your agent calls the operations by intent.
- **Permission scoping:** The client code and contract id travel in the URL path, so a rule can bind the agent to a single client's contracts. You grant only the operations it needs, for example reading schedules and taking payments while withholding cancellations, and every call is logged.
- **Credential handling:** Your API key is stored encrypted on your own Jentic One instance and injected into the apiKey header at execution time, never placed in the agent's prompt, logs, or context. You rotate or revoke it in one place without touching agent code.
- **Discovery method:** Agents search Jentic by intent such as 'open a Direct Debit contract' or 'take a payment', and Jentic returns the matching Access PaySuite operation with its input schema so the agent calls the right endpoint without reading the reference docs.

## Related APIs

- **GoCardless** — A Direct Debit specialist covering UK BACS and international bank-to-bank collection.
- **Stripe** — A broad payments platform offering Direct Debit alongside cards and wallets.
- **Adyen Checkout Service** — Enterprise payment processing spanning many payment methods and regions.
- **Xero Accounting API** — Reconcile collected Direct Debit payments into the accounting ledger.

## FAQ

### What authentication does the Access PaySuite API use?

The spec declares an apiKey scheme that sends your key in an apiKey header, so every request carries that key. Through Jentic, your own Jentic One instance stores the key encrypted and attaches it to each call rather than exposing it to the agent.

### Can I pause or change a Direct Debit after it is set up?

Yes. Each contract has dedicated actions to change the amount, switch frequency, freeze a run of cycles, skip the next payment, cancel, restart, or reactivate. You read the contract's future schedules afterwards to confirm the change took effect.

### What are the rate limits for the Access PaySuite API?

The OpenAPI spec does not state rate limits. Check the official Access PaySuite documentation at https://developer.accesspaysuite.com/ for current limits before running large bulk payment jobs.

### How do I collect Direct Debits through Jentic?

Add the Access PaySuite API from the Jentic API Directory and connect your key once. Your agent then searches by intent such as 'open a Direct Debit contract' and calls the matching operation. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I restrict which Access PaySuite operations my agent is allowed to call?

Yes. The client code and contract id travel in the URL path, so a rule can bind the agent to a single client's contracts and allow only the operations it needs, such as reading schedules while withholding payment collection. Every call the agent makes is logged.

### Is there an Access PaySuite MCP server?

You don't need an MCP server to use Access PaySuite with your agent. Jentic connects it directly from the API Directory: import it, connect your key once, and your agent can create contracts and take payments without another server loading tool definitions into its context.