---
title: "DirectDebit:Add"
method: POST
path: "/directdebits"
tags: ["Directdebits"]
---

# DirectDebit:Add

`POST /directdebits`

Initiate a DirectDebit for a Mandate. Only applicable for “Flexible” mandates.

## Request body

- object
  - `mandate` Code — unresolved $ref
  - `processDate` ProcessDate — unresolved $ref
  - `description` Description — unresolved $ref
  - `amount` Amount, required
    - `value` integer, required — The amount in cents.
    - `currency` string — The currency in ISO-4217 format.
  - `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
  - `isLastOrder` boolean — Indicate whether this is the last direct debit for this mandateId.

## Response `200`

Ok.

- object
  - `directdebit` Directdebit
    - `id` string — The direct debit identifier.
    - `description` string — The description of the direct debit.
    - `url` string, uri — The url of the service connected to the direct debit.
    - `processDate` string, date-time — The date at which this entity will be processed
    - `orderId` string — The orderId of the transaction.
    - `paymentSessionId` string — The payment session identifier.
    - `type` string — The type of direct debit. One of: single, mandate, recurring.
    - `amount` Amount
      - `value` integer, required — The amount in cents.
      - `currency` string — The currency in ISO-4217 format.
    - `status` Status
      - `code` integer — The status code.
      - `action` string — The state in which the transaction resides
      - `phase` string — The current phase in the transaction state
    - `declined` string — Indicator if the direct debit was declined.
    - `decline` object
      - `code` integer — The unique code of the decline reason.
      - `name` string — A short description of the decline reason.
      - `date` string, date-time — The date at which this direct debit was declined.
    - `bankAccount` BankAccount
      - `iban` string, required — The International Bank Account Number (IBAN).
      - `bic` string, required — Business Identifier Codes (BIC/SWIFT).
      - `owner` string, required — The owner of the bank account.
    - `mandate` object — string>
      - `code` Code — unresolved $ref
      - `name` Description — unresolved $ref
      - `reference` Reference — unresolved $ref
    - `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
    - `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)