---
title: "Mandates:Browse"
method: GET
path: "/directdebits/mandates"
tags: ["Directdebits"]
---

# Mandates:Browse

`GET /directdebits/mandates`

List all mandates on which a direct debit transaction can be executed

## Query parameters

- `type` object
  - `eq` string — Get results that equal the given value
  - `neq` string — Get results that do not equal the given value
- `merchant` object
  - `eq` string — Get results that equal the given value
  - `neq` string — Get results that do not equal the given value

## Response `200`

Ok.

- object
  - `mandate` Mandate
    - `code` string — The unique identifier of the mandate.
    - `serviceId` Id — unresolved $ref
    - `reference` string, nullable — The reference that will be added to the related transactions.
    - `description` string — The description of the mandate.
    - `processDate` string, date-time, nullable — The date at which this entity will be processed
    - `exchangeUrl` string, uri, nullable — The exchange URL which will be called when the direct debit is executed.
    - `type` string — The type of mandate. One of: SINGLE, RECURRING, FLEXIBLE.
    - `interval` Interval
      - `period` 'day' | 'week' | 'month' | 'trimester' | 'halfyear' | 'year' — Specify the period frequency. Must be one of: day,week,month,trimester,halfyear,year.
      - `quantity` integer — Indicated the number of times this order should be executed.
      - `value` integer — Specify the frequency for a period. For example, a weekly period, but only every second week.
    - `amount` Amount
      - `value` integer, required — The amount in cents.
      - `currency` string — The currency in ISO-4217 format.
    - `customer` object
      - `email` Email — unresolved $ref
      - `ipAddress` Ip — unresolved $ref
      - `bankAccount` object
        - `iban` string, required — The International Bank Account Number (IBAN).
        - `bic` string — Business Identifier Codes (BIC/SWIFT).
        - `owner` string, required — The owner of the bank account.
    - `statistics` Stats
      - `info` string — The used info code which can be tracked in the stats.
      - `tool` string — The used tool code which can be tracked in the stats.
      - `object` string — The object which can be tracked in stats.
      - `extra1` string — The first free value which can be tracked in the stats.
      - `extra2` string — The second free value which can be tracked in the stats.
      - `extra3` string — The third free value which can be tracked in the stats.
      - `domainId` string — The ID of the duplicate content URL
    - `service` object — string>
      - `code` Id — unresolved $ref
      - `name` Name — unresolved $ref
    - `merchant` MerchantMinimal
      - `code` string, required — The merchant id of your company starting with M.
      - `name` string, required — The name of your merchant.
      - `status` string, required — Merchant state
      - `incorporationCountry` string — The incorporationCountry field represents the country in which the entity is legally registered or incorporated.
    - `stats` Stats
      - `info` string — The used info code which can be tracked in the stats.
      - `tool` string — The used tool code which can be tracked in the stats.
      - `object` string — The object which can be tracked in stats.
      - `extra1` string — The first free value which can be tracked in the stats.
      - `extra2` string — The second free value which can be tracked in the stats.
      - `extra3` string — The third free value which can be tracked in the stats.
      - `domainId` string — The ID of the duplicate content URL
    - `lastDirectDebitDate` string, date-time, nullable — The date at which the last direct debit was executed.
    - `nextDirectDebitDate` string, date-time, nullable — The date at which the direct debit is scheduled to be executed.
    - `actualDirectDebitDate` string, date-time, nullable — The date at which the direct debit will be executed.
    - `createdAt` CreatedAt — unresolved $ref
    - `createdBy` CreatedBy — unresolved $ref
    - `modifiedAt` ModifiedAt — unresolved $ref
    - `modifiedBy` ModifiedBy — unresolved $ref
    - `deletedAt` DeletedAt — unresolved $ref
    - `deletedBy` DeletedBy — unresolved $ref

## Other responses

- `400` — Bad request, see response body for more information
- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `404` — Resource not found
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `422` — Unprocessable entity, see response body for more information
- `429` — Rate limit reached.
- `500` — An internal error occurred

---

[API](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/revisions/2bc260c7bdfc/schema)