---
title: "Get mandate"
method: GET
path: "/v0/mandates/{mandate-id}"
tags: ["Mandates"]
---

# Get mandate

`GET /v0/mandates/{mandate-id}`

Fetch a mandate.

## Path parameters

- `mandate-id` string, required

## Response `200`

OK

- union — A direct debit mandate.
  - object
    - `collection-amount` union, required — The collection amount configuration for the mandate.
      - object
        - `max-amount` object — Compound value representing both the currency and amount of money being sent.
          - `currency` 'GBP', required
          - `value` string, required — The value as a decimal-formatted string
        - `amount-type` 'variable', required
      - object
        - `amount` object, required — Compound value representing both the currency and amount of money being sent.
          - `currency` 'GBP', required
          - `value` string, required — The value as a decimal-formatted string
        - `amount-type` 'fixed', required
    - `cancellation-reason` 'cancelled-by-griffin' | 'debtor-deceased' | 'cancelled-by-creditor' | 'account-closed' | 'cancelled-by-debtor', required
    - `mandate-payments-url` union, required — Link to the payments associated with this mandate.
      - string
      - string
    - `mandate-scheme-information` object, required — Scheme-specific details for the mandate.
      - `unique-scheme-id` string — The scheme's unique reference for the mandate.
      - `payment-scheme` 'bacs', required
    - `last-used-at` string, date-time — When a payment was most recently collected under this mandate. Absent until the first collection.
    - `creditor` union, required
      - object
        - `payee-url` union, required — Link to the [payee](#tag/Payees).
          - string
          - string
        - `creditor-type` 'payee', required
      - object
        - `account-url` union, required — Link to the bank account resource.
          - string
          - string
        - `creditor-type` 'griffin-bank-account', required
      - object — Creditor specified with bank details
        - `iban` string — An International Bank Account Number.
        - `uk-domestic-sort-code` string — A UK sort code.
        - `bic` string — A BIC.
        - `account-number` string — A UK account number.
        - `account-holder` string — The name of the [account holder](/docs/terms/account-holder).
        - `bank-id-code` 'gbdsc'
        - `bank-id` string — A UK sort code.
        - `creditor-type` 'uk-domestic', required
        - `bban` string — A country-specific Basic Bank Account Number.
        - `account-url` union — Link to the bank account resource.
          - string
          - string
        - `uk-domestic-account-number` string — A UK account number.
        - `other-account-identification` string — Uncategorised account identification
        - `account-number-code` 'bban'
        - `other-institution-identification` string — Uncategorised financial institution identification
    - `status` 'cancelled' | 'active' | 'expired', required
    - `created-at` string, date-time, required — ISO 8601 formatted date-time.
    - `collection-frequency` 'yearly' | 'daily' | 'fortnightly' | 'monthly' | 'weekly' | 'on-demand' | 'bimonthly' | 'quarterly', required
    - `reference` string, required — The reference identifying this mandate, assigned by the creditor.
    - `debtor` object, required — The account being debited. Resolve the account holder and details from `account-url`.
      - `account-url` union, required — Link to the bank account resource.
        - string
        - string
    - `mandate-url` union, required — Link to a direct debit mandate.
      - string
      - string
  - object
    - `collection-amount` union, required — The collection amount configuration for the mandate.
      - object
        - `max-amount` object — Compound value representing both the currency and amount of money being sent.
          - `currency` 'GBP', required
          - `value` string, required — The value as a decimal-formatted string
        - `amount-type` 'variable', required
      - object
        - `amount` object, required — Compound value representing both the currency and amount of money being sent.
          - `currency` 'GBP', required
          - `value` string, required — The value as a decimal-formatted string
        - `amount-type` 'fixed', required
    - `mandate-payments-url` union, required — Link to the payments associated with this mandate.
      - string
      - string
    - `mandate-scheme-information` object, required — Scheme-specific details for the mandate.
      - `unique-scheme-id` string — The scheme's unique reference for the mandate.
      - `payment-scheme` 'bacs', required
    - `last-used-at` string, date-time — When a payment was most recently collected under this mandate. Absent until the first collection.
    - `creditor` union, required
      - object
        - `payee-url` union, required — Link to the [payee](#tag/Payees).
          - string
          - string
        - `creditor-type` 'payee', required
      - object
        - `account-url` union, required — Link to the bank account resource.
          - string
          - string
        - `creditor-type` 'griffin-bank-account', required
      - object — Creditor specified with bank details
        - `iban` string — An International Bank Account Number.
        - `uk-domestic-sort-code` string — A UK sort code.
        - `bic` string — A BIC.
        - `account-number` string — A UK account number.
        - `account-holder` string — The name of the [account holder](/docs/terms/account-holder).
        - `bank-id-code` 'gbdsc'
        - `bank-id` string — A UK sort code.
        - `creditor-type` 'uk-domestic', required
        - `bban` string — A country-specific Basic Bank Account Number.
        - `account-url` union — Link to the bank account resource.
          - string
          - string
        - `uk-domestic-account-number` string — A UK account number.
        - `other-account-identification` string — Uncategorised account identification
        - `account-number-code` 'bban'
        - `other-institution-identification` string — Uncategorised financial institution identification
    - `status` 'cancelled' | 'active' | 'expired', required
    - `created-at` string, date-time, required — ISO 8601 formatted date-time.
    - `collection-frequency` 'yearly' | 'daily' | 'fortnightly' | 'monthly' | 'weekly' | 'on-demand' | 'bimonthly' | 'quarterly', required
    - `reference` string, required — The reference identifying this mandate, assigned by the creditor.
    - `debtor` object, required — The account being debited. Resolve the account holder and details from `account-url`.
      - `account-url` union, required — Link to the bank account resource.
        - string
        - string
    - `mandate-url` union, required — Link to a direct debit mandate.
      - string
      - string
  - object
    - `collection-amount` union, required — The collection amount configuration for the mandate.
      - object
        - `max-amount` object — Compound value representing both the currency and amount of money being sent.
          - `currency` 'GBP', required
          - `value` string, required — The value as a decimal-formatted string
        - `amount-type` 'variable', required
      - object
        - `amount` object, required — Compound value representing both the currency and amount of money being sent.
          - `currency` 'GBP', required
          - `value` string, required — The value as a decimal-formatted string
        - `amount-type` 'fixed', required
    - `mandate-payments-url` union, required — Link to the payments associated with this mandate.
      - string
      - string
    - `mandate-scheme-information` object, required — Scheme-specific details for the mandate.
      - `unique-scheme-id` string — The scheme's unique reference for the mandate.
      - `payment-scheme` 'bacs', required
    - `last-used-at` string, date-time — When a payment was most recently collected under this mandate. Absent until the first collection.
    - `creditor` union, required
      - object
        - `payee-url` union, required — Link to the [payee](#tag/Payees).
          - string
          - string
        - `creditor-type` 'payee', required
      - object
        - `account-url` union, required — Link to the bank account resource.
          - string
          - string
        - `creditor-type` 'griffin-bank-account', required
      - object — Creditor specified with bank details
        - `iban` string — An International Bank Account Number.
        - `uk-domestic-sort-code` string — A UK sort code.
        - `bic` string — A BIC.
        - `account-number` string — A UK account number.
        - `account-holder` string — The name of the [account holder](/docs/terms/account-holder).
        - `bank-id-code` 'gbdsc'
        - `bank-id` string — A UK sort code.
        - `creditor-type` 'uk-domestic', required
        - `bban` string — A country-specific Basic Bank Account Number.
        - `account-url` union — Link to the bank account resource.
          - string
          - string
        - `uk-domestic-account-number` string — A UK account number.
        - `other-account-identification` string — Uncategorised account identification
        - `account-number-code` 'bban'
        - `other-institution-identification` string — Uncategorised financial institution identification
    - `status` 'cancelled' | 'active' | 'expired', required
    - `created-at` string, date-time, required — ISO 8601 formatted date-time.
    - `collection-frequency` 'yearly' | 'daily' | 'fortnightly' | 'monthly' | 'weekly' | 'on-demand' | 'bimonthly' | 'quarterly', required
    - `reference` string, required — The reference identifying this mandate, assigned by the creditor.
    - `debtor` object, required — The account being debited. Resolve the account holder and details from `account-url`.
      - `account-url` union, required — Link to the bank account resource.
        - string
        - string
    - `mandate-url` union, required — Link to a direct debit mandate.
      - string
      - string

## Other responses

- `400` — Bad Request
- `401` — Requires an API key to continue
- `404` — Not Found

---

[API](https://skmtc.net/griffin/apis/the-griffin-api.md) · [All operations](https://skmtc.net/griffin/apis/the-griffin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/griffin/the-griffin-api/revisions/e56cd4bb9677/schema)