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
required

National ID (ת"ז) of the debtor/PSU who approves and is charged. Sent as the PSU-ID header and as the debtor private identification.

string

Corporate ID (ח"פ) — only when the debtor is a business. Sent as PSU-Corporate-ID and makes the debtor an organisationId.

string

PSU ID type. Optional; defaults to the provider's default.

string

PSU corporate ID type. Optional; defaults to the provider's default.

string

Bank (ASPSP) id, e.g. hapoalim, leumi, beinleumi. Optional — auto-detected from debtorAccountNumber if omitted.

integer

Bank number, alternative to providerId.

string
enum

API version.

Allowed:
string
^\/.*[a-zA-Z]$

Path the bank redirects to after SCA.

mandateInformation
object
required
Headers
string

IP address of the PSU (Payment Service User)

Responses

Updated 19 days ago

Did this page help you?
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 19 days ago

Did this page help you?