Start a mandate at the bank

Starts a mandate at the bank and returns scaOAuth, the bank approval link, like POST /v2/pay/open-banking-init for payments and POST /v2/connect/open-banking-init for connections.

  • With mandateId: starts a mandate created with POST /v2/mandates. The terms come from it; the account is the one sent when the link was created, or otherwise the one in the request.
  • Without mandateId: creates a new mandate from mandateInformation and starts it in the same call.

A business customer sends both psuCorporateId and psuId. The support tables on POST /v2/mandates apply here too.

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

Send either mandateId or mandateInformation.

string

A mandate created with POST /v2/mandates. Without it, a new mandate is created from mandateInformation, as POST /v2/pay/open-banking-init does for payments.

string
required

The bank, e.g. hapoalim, leumi, mizrahi. With a mandateId it must be one of the banks the link offers.

string
required

National ID (ת"ז) of the person who approves at the bank. Must match the psuId the link was created for.

string

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

string

Company number (ח"פ) when the customer is a business. The bank receives it as organisationId together with psuId as privateId.

string

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

string
enum

With a mandateId: format of the account to charge. Send it together with debtorAccountNumber. When an account was sent at POST /v2/mandates, that account is always used.

Allowed:
string

With a mandateId: the account to charge.

mandateInformation
object

The terms of a new mandate. Not allowed together with mandateId.

boolean
Defaults to false

Required to create a new mandate at a sandbox bank.

string

Where to send the customer after the bank. Must be in your allowed domains. With a mandateId it replaces the one saved at POST /v2/mandates, as in POST /v2/pay/open-banking-init.

string
enum

API version.

Allowed:
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