Create a mandate resource

Creates a mandate (הרשאה לחיוב חשבון). By default it is created at the ASPSP for the account in the request and returns scaOAuth for the customer's approval. With useJourney it returns mandateUrl, a journey link where the customer picks the bank, enters the account and approves.

Time period support by bank (verified against production, 2026-10-19). mandateInformation.frequency and mandateInformation.startDate map to occurrences.frequencyType and occurrences.firstCollectionDate, which are optional in the BOI mandates standard, so not every bank supports them.

ProviderWithout time periodWith time periodFrequencies
hapoalimSupportedSupportedWeekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, Annual (not SemiAnnual)
mizrahiSupportedSupportedWeekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual
leumiSupportedNot supported-
discountSupportedNot supported-
beinleumiSupportedNot supported-

A time period sent for a provider that does not support it is refused before the bank is called, with 400 PARAMETER_NOT_SUPPORTED naming what is supported, e.g. mandateInformation.frequency is not supported for provider leumi. Supported providers: hapoalim, mizrahi.

Expiry (mandateInformation.endDate) support by bank (verified against production, 2026-10-19). Send one date; Open Finance sends it to each bank in the field that bank accepts.

ProviderExpirySent to the bank as
hapoalimSupportedoccurrences.duration.toDate
mizrahiSupportedoccurrences.duration.toDate
beinleumiSupportedoccurrences.duration.toDate (it fails finalCollectionDate)
leumiSupportedoccurrences.finalCollectionDate (it refuses duration)
discountSupportedoccurrences.finalCollectionDate (it refuses duration)
other banksNot supported-

Validation, all answered with 400 before the bank is called:

  • mandateInformation.endDate must be a date in the format YYYY-MM-DD.
  • mandateInformation.endDate must be after today (YYYY-MM-DD). (Israel date)
  • mandateInformation.endDate must be after mandateInformation.startDate (YYYY-MM-DD).
  • mandateInformation.endDate is not supported for provider X. Supported providers: beinleumi, discount, hapoalim, leumi, mizrahi. (PARAMETER_NOT_SUPPORTED)

On a journey link the bank is known only when the customer picks it, so the expiry is checked again at that point.

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

National ID (ת"ז) of the debtor/PSU who approves and is charged. Sent as the PSU-ID header and as the debtor private identification. Required unless useJourney is true (then the customer enters it in the journey; if sent, it is prefilled and enforced).

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. With useJourney it pins the bank the customer must use, and it is required when mandateInformation.frequency or mandateInformation.startDate is set, because a time period is supported only by some banks.

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

debtorAccountType and debtorAccountNumber are required unless useJourney is true.

boolean
Defaults to false

false (default): create the mandate at the bank now and return scaOAuth. true: save a pending mandate and return mandateUrl, a link to the Open Finance journey where the customer picks the bank, enters the account and approves.

boolean
Defaults to false

With useJourney: offer sandbox banks in the journey.

boolean
Defaults to false

With useJourney: let the customer choose a business account and enter a company number (ח"פ).

string

With useJourney: where to send the customer when the journey ends.

Headers
string

IP address of the PSU (Payment Service User)

Responses

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