OPopen-finance

Create a mandate resource

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

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

Headers

psu-ip-addressstring ipv4

IP address of the PSU (Payment Service User)

Request body

mandateIdstring

Unique identification, as assigned by the creditor, to unambiguously identify the mandate

reasonCodestring

Provides the reason for the setup of the mandate as an ISO code

reasonProprietarystring

Provides the reason for the setup of the mandate as a proprietary code

mandateReferencestring

Reference assigned by a creditor or ultimate creditor for internal usage for the mandate

psuIdstring

A unique identifier for the customer (tehudat zehut)

psuIdTypestring

Type of PSU ID

psuCorporateIdstring

Corporate ID for business users

psuCorporateIdTypestring

Type of corporate ID

version'v1.8'

API version to use for this request

providerIdstring

A unique identifier aspsp (financial institution)

redirectFinalizePathstring

Path for redirect finalization

Response

Mandate created successfully

mandateIdstring

Unique identification of the mandate

mandateStatus'received' | 'valid' | 'partiallyAuthorised' | 'rejected' | 'revokedByPSU' | 'expired' | 'terminatedByTPP' | 'suspended'

The status of the mandate resource

scaOAuthstring

URI where the configuration of the Authorisation Server can be retrieved (OAuth 2.0 Authorisation Server Metadata)

Changes

No recorded changes to this operation across all 1 revision of this API.