Sign in

v1

latestOpenAPI 3.0.02026-07-268955283.0 KB

Create a mandate resource

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

post/v2/mandates

Headers

psu-ip-addressstring ipv4

IP address of the PSU (Payment Service User)

Request body

psuIdstring required

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

psuCorporateIdstring

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

psuIdTypestring

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

psuCorporateIdTypestring

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

providerIdstring

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

providerBankNumberinteger

Bank number, alternative to providerId.

version'v1.8'

API version.

redirectFinalizePathstring

Path the bank redirects to after SCA.

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)