API Reference

Create a mandate resource

post
https://{API_PREFIX}.open-finance.ai/v2/v2/mandates

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length ≤ 35

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

type
object
required
occurrences
object
firstCollectionAmount
object
collectionAmount
object
maximumAmount
object
string

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

string
length ≤ 35

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

creditorSchemeIdentification
object
creditor
object
required
creditorAccount
object
creditorAgent
object
ultimateCreditor
object
debtor
object
debtorAccount
object
required
ultimateDebtor
object
string
length ≤ 35

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

referredDocument
object
string

A unique identifier for the customer (tehudat zehut)

string

Type of PSU ID

string

Corporate ID for business users

string

Type of corporate ID

string
enum

API version to use for this request

Allowed:
string

A unique identifier aspsp (financial institution)

string

Path for redirect finalization

Headers
string

IP address of the PSU (Payment Service User)

Responses

Updated 26 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 26 days ago