---
title: "Create a mandate resource"
method: POST
path: "/v2/mandates"
---

# Create a mandate resource

`POST /v2/mandates`

Creates a mandate resource at the ASPSP for the account specified in this request

## Headers

- `psu-ip-address` string, ipv4

## Request body

- CreateMandateRequest
  - `psuId` string, required — National ID (ת"ז) of the debtor/PSU who approves and is charged. Sent as the PSU-ID header and as the debtor private identification.
  - `psuCorporateId` string — Corporate ID (ח"פ) — only when the debtor is a business. Sent as PSU-Corporate-ID and makes the debtor an organisationId.
  - `psuIdType` string — PSU ID type. Optional; defaults to the provider's default.
  - `psuCorporateIdType` string — PSU corporate ID type. Optional; defaults to the provider's default.
  - `providerId` string — Bank (ASPSP) id, e.g. hapoalim, leumi, beinleumi. Optional — auto-detected from debtorAccountNumber if omitted.
  - `providerBankNumber` integer — Bank number, alternative to providerId.
  - `version` 'v1.8' — API version.
  - `redirectFinalizePath` string — Path the bank redirects to after SCA.
  - `mandateInformation` object, required
    - `creditorInstitutionCode` string, required — קוד מוסד — the creditor (מוטב) institution code registered at מס"ב. Maps to creditor.identification.organisationId (the standard's Creditor ID).
    - `debtorAccountType` 'bban' | 'iban', required — Format of the debtor account number.
    - `debtorAccountNumber` string, required — The account that will be charged. Auto-converted to the provider's required format.
    - `amount` number — How much is charged each time. Optional.
    - `maxAmount` number — Ceiling the bank will not exceed per charge. Optional.
    - `currency` string — ISO 4217 currency. Default ILS.
    - `frequency` 'Daily' | 'Weekly' | 'EveryTwoWeeks' | 'Monthly' | 'EveryTwoMonths' | 'Quarterly' | 'SemiAnnual' | 'Annual' | 'MonthlyVariable' — How often the account is charged. Optional.
    - `sequenceType` 'RCUR' | 'OOFF' | 'FRST' | 'FNAL' — RCUR (recurring, default), OOFF (one-off), FRST, FNAL.
    - `startDate` string, date — Date of the first charge (ISO yyyy-mm-dd). Optional.
    - `localInstrumentCode` string — Direct-debit instrument. Default MASAV. Advanced override.
    - `mandateReference` string — מספר אסמכתא — the creditor's reference for this authorization. Optional.

## Response `200`

Mandate created successfully

- CreateMandateResponse
  - `mandateId` string — Unique identification of the mandate
  - `mandateStatus` 'received' | 'valid' | 'partiallyAuthorised' | 'rejected' | 'revokedByPSU' | 'expired' | 'terminatedByTPP' | 'suspended' — The status of the mandate resource
  - `scaOAuth` string — URI where the configuration of the Authorisation Server can be retrieved (OAuth 2.0 Authorisation Server Metadata)

## Other responses

- `400` — Validation Error
- `401` — Unauthorized, token is missing
- `403` — Forbidden, token has no valid scopes
- `500` — Internal Server Error

---

[API](https://skmtc.net/open-finance/apis/auth.md) · [All operations](https://skmtc.net/open-finance/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/open-finance/auth/versions/b4d401b65c3d/schema)
