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

# Create a mandate resource

`POST /v2/mandates`

## Request

- Base URL: `https://api.open-finance.ai/v2`
- URL: `https://api.open-finance.ai/v2/v2/mandates`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.open-finance.ai/oauth/token` scopes: `create:mandates`

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

## Headers

- `psu-ip-address` string, ipv4

## Request body

- CreateMandateRequest
  - `mandateId` string: Unique identification, as assigned by the creditor, to unambiguously identify the mandate
  - `type` object, required
    - `localInstrumentCode` string: Agreement under which or rules under which the transaction should be processed
    - `serviceLevelCode` string: Agreement under which or rules under which the transaction should be processed, provided as a code
  - `occurrences` object
    - `sequenceType` string: Sequence type of the occurrence
    - `frequencyType` string: Frequency of the occurrence
    - `firstCollectionDate` string, date: First collection date
  - `firstCollectionAmount` object
    - `currency` string: ISO 4217 Alpha 3 currency code
    - `amount` string: The amount given with fractional digits
  - `collectionAmount` object
    - `currency` string: ISO 4217 Alpha 3 currency code
    - `amount` string: Fixed amount to be collected from the debtor's account
  - `maximumAmount` object
    - `currency` string: ISO 4217 Alpha 3 currency code
    - `amount` string: Maximum amount that may be collected from the debtor's account, per instruction
  - `reasonCode` string: Provides the reason for the setup of the mandate as an ISO code
  - `reasonProprietary` string: Provides the reason for the setup of the mandate as a proprietary code
  - `creditorSchemeIdentification` object
    - `name` string
    - `other` object
      - `identification` string
  - `creditor` object, required
    - `name` string
    - `other` object
      - `identification` string
  - `creditorAccount` object
    - `iban` string
    - `bban` string
    - `maskedPan` string
    - `msisdn` string
    - `currency` string
    - `other` object
      - `identification` string
    - `cashAccountType` string
  - `creditorAgent` object
    - `bic` string
    - `name` string
  - `ultimateCreditor` object
    - `name` string
    - `other` object
      - `identification` string
  - `debtor` object
    - `name` string
    - `other` object
      - `identification` string
  - `debtorAccount` object, required
    - `iban` string
    - `bban` string
    - `maskedPan` string
    - `msisdn` string
    - `currency` string
    - `identification` string
    - `other` object
      - `identification` string
    - `cashAccountType` string
  - `ultimateDebtor` object
    - `name` string
    - `other` object
      - `identification` string
  - `mandateReference` string: Reference assigned by a creditor or ultimate creditor for internal usage for the mandate
  - `referredDocument` object
    - `type` string
    - `number` string
  - `psuId` string: A unique identifier for the customer (tehudat zehut)
  - `psuIdType` string: Type of PSU ID
  - `psuCorporateId` string: Corporate ID for business users
  - `psuCorporateIdType` string: Type of corporate ID
  - `version` 'v1.8': API version to use for this request
  - `providerId` string: A unique identifier aspsp (financial institution)
  - `redirectFinalizePath` string: Path for redirect finalization

## 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.dev/open-finance/apis/data.md) - [All operations](https://skmtc.dev/open-finance/apis/data/llms.txt) - [OpenAPI document](https://skmtc.dev/open-finance/apis/data/revisions/c18eafb2a770?raw)