---
title: "Initiate a payment with a provider"
method: POST
path: "/pay/open-banking-init"
---

# Initiate a payment with a provider

`POST /pay/open-banking-init`

## Request body

- union
  - object
    - `version` '1.8' — API version to use for this request
    - `withEndToEndId` boolean — If true, generates an End-to-End identification for the payment transaction
    - `psuId` string — national id or passport number of the end-user
    - `psuCorporateId` string — The business ID of a customer (business incorporation id)
    - `callbackInformation` CallbackInformation — Webhook and callback configuration stored on the connection (mirrors organization callback shape where applicable)
      - `webhooks` object, nullable
        - `enabled` boolean, nullable — If true, enable webhooks
        - `successUrl` string, nullable — The url endpoint for success events
        - `failUrl` string, nullable — The url endpoint for fail events
        - `abortUrl` string, nullable — The url endpoint for abort events
        - `oauth` object, nullable
          - `enabled` boolean, nullable — Whether OAuth is used to authenticate webhook calls
          - `clientId` string, nullable
          - `clientSecret` string, nullable
          - `audience` string, nullable
          - `scope` string, nullable
          - `tokenUrl` string, nullable
        - `basic` object, nullable — Optional basic-auth configuration for webhooks
          - `enabled` boolean, nullable
          - `username` string, nullable
          - `password` string, nullable
          - `tokenUrl` string, nullable
        - `customHeaders` object, nullable — Extra HTTP headers sent with webhook requests
        - `products` string[], nullable — Which products emit webhooks for this configuration
    - `redirectFinalizePath` string — An optional path that is appended to the tppRedirectUrl in open banking payments. During the finalize step of the payment process, the user will be redirected to this specified path instead of the Open-Finance URL.
    - `includeFakeProviders` boolean — If true, this payment can be used with fake providers
    - `psuIdType` string
    - `providerId` 'yahav-sandbox' | 'yahav' | 'undefined' | 'ubank-sandbox' | 'ubank' | 'pepper' | 'pagi-sandbox' | 'pagi' | 'otsarHahayal-sandbox' | 'otsarHahayal' | 'open-finance-sandbox' | 'open-finance-card-sandbox' | 'mizrahi-sandbox' | 'mizrahi' | 'mercantile-sandbox' | 'mercantile' | 'menora-sandbox' | 'max-sandbox' | 'max' | 'masad-sandbox' | 'masad' | 'leumi-sandbox' | 'leumi' | 'isracard-sandbox' | 'isracard' | 'hapoalim-sandbox' | 'hapoalim' | 'discount-sandbox' | 'discount' | 'cal-sandbox' | 'cal' | 'beinleumi-sandbox' | 'beinleumi' | 'americanExpress', required — A unique identifier for the provider
    - `paymentId` string, required — If a payment was created before via the create-payment route you can specify its id here
    - `paymentProduct` string
    - `paymentService` 'masav' | 'fp' | 'zahav' — The type of the payment service
    - `externalId` string — An optional id that can be given to a payment
    - `paymentInformation` object — The information of the payment
      - `merchantId` string — A unique identifier for the merchant
      - `amount` number, required — The amount of the payment (must be greater than 0)
      - `currency` string, required — The currency of the payment
      - `description` string, required — the description of the payment
      - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
      - `creditorAccountNumber` string — The account number of the creditor. Must be in bban format if creditorAccountType is bban, and in iban format if creditorAccountType is iban. Example of bban: '10-944-50151142'. Example of iban: 'IL123456789012345678901'
      - `debtorId` string — (Optional) debtorId allows the debtor to select his account after authenticating in the bank without providing the account number and type. When provided, debtorAccountNumber and debtorAccountType must NOT be provided (mutually exclusive).
      - `debtorAccountType` 'bban' | 'iban' — The type of the account number of the debtor. Required when debtorId is not provided. Must be omitted when debtorId is provided.
      - `debtorAccountNumber` string — The account number of the debtor. Required when debtorId is not provided. Must be omitted when debtorId is provided. Must be in bban format if debtorAccountType is bban, and in iban format if debtorAccountType is iban. Example of bban: '10-944-50151142'. Example of iban: 'IL123456789012345678901'
      - `creditorName` string — The name of the creditor
      - `debtorName` string — The name of the debtor
      - `requestedExecutionDate` string, date — The date when the future payment should be executed (mutually exclusive with requestedExecutionTime)
      - `requestedExecutionTime` string, date-time — The date-time when the future payment should be executed (mutually exclusive with requestedExecutionDate)
    - `bulkPaymentInformation` object — The information of the bulk payment (only one of paymentInformation, bulkPaymentInformation, or paymentId should be provided)
      - `debtorAccountNumber` string, required — The account number of the debtor
      - `debtorAccountType` 'bban' | 'iban', required — The type of the account number of the debtor
      - `batchBookingPreferred` boolean — If true, the PSU prefers only one booking entry. If false, individual booking of all contained transactions
      - `paymentInformationId` string — Unique identification for this bulk payment
      - `requestedExecutionDate` string, date — The date when the payments should be executed (mutually exclusive with requestedExecutionTime)
      - `requestedExecutionTime` string, date-time — The date-time when the payments should be executed (mutually exclusive with requestedExecutionDate)
      - `payments` object[], required
        - `merchantId` string — A unique identifier for the merchant
        - `amount` number, required — The amount of the payment (must be greater than 0)
        - `currency` string, required — The currency of the payment (must be ILS for bulk payments)
        - `description` string, required — The description of the payment
        - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
        - `creditorAccountNumber` string — The account number of the creditor
        - `creditorName` string — The name of the creditor
    - `periodicPaymentInformation` object — The information for periodic/recurring payments (only one of paymentInformation, bulkPaymentInformation, periodicPaymentInformation, or paymentId should be provided)
      - `merchantId` string — A unique identifier for the merchant
      - `amount` number, required — The amount of each periodic payment
      - `currency` string, required — The currency of the periodic payment
      - `description` string, required — Remittance information for the periodic payment
      - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
      - `creditorAccountNumber` string — The account number of the creditor
      - `creditorName` string — The name of the creditor
      - `debtorAccountNumber` string, required — The account number of the debtor
      - `debtorAccountType` 'bban' | 'iban', required — The type of the account number of the debtor
      - `debtorName` string — The name of the debtor
      - `startDate` string, date, required — The first applicable day of execution
      - `endDate` string, date — The last applicable day of execution (optional, if not provided the standing order is infinite)
      - `frequency` 'Daily' | 'Weekly' | 'EveryTwoWeeks' | 'Monthly' | 'EveryTwoMonths' | 'Quarterly' | 'SemiAnnual' | 'Annual' | 'MonthlyVariable', required — The frequency of the recurring payment
      - `executionRule` 'following' | 'preceding' — Defines behavior when payment date falls on weekend/holiday
      - `dayOfExecution` string — Day of month for execution (1-31, where 31 means ultimo)
      - `monthsOfExecution` string[] — Array of months (1-12) for execution. Only valid when frequency is 'MonthlyVariable'
    - `redirectUrl` string — The URL to which the user will be redirected after the payment is completed
    - `rtpPaymentInformation` object — RTP (Request to Pay) payment information
      - `amount` number, required — Payment amount
      - `currency` 'ILS', required — Payment currency (ILS only)
      - `description` string, required — Payment description
      - `debtorAccountNumber` string, required — Debtor (payer) account number
      - `debtorAccountType` 'iban' | 'bban', required
      - `creditorAccountNumber` string — Creditor account number (optional, uses merchant if not provided)
      - `creditorAccountType` 'iban' | 'bban'
      - `creditorName` string
      - `expiryDateTime` string — RTP expiry in ISO format
      - `requestedExecutionDate` string — Execution date (YYYY-MM-DD)
      - `requestedExecutionDateTime` string — Execution datetime in ISO format. Must be a future date.
  - object
    - `version` '1.8' — API version to use for this request
    - `withEndToEndId` boolean — If true, generates an End-to-End identification for the payment transaction
    - `psuId` string — national id or passport number of the end-user
    - `psuCorporateId` string — The business ID of a customer (business incorporation id)
    - `callbackInformation` CallbackInformation — Webhook and callback configuration stored on the connection (mirrors organization callback shape where applicable)
      - `webhooks` object, nullable
        - `enabled` boolean, nullable — If true, enable webhooks
        - `successUrl` string, nullable — The url endpoint for success events
        - `failUrl` string, nullable — The url endpoint for fail events
        - `abortUrl` string, nullable — The url endpoint for abort events
        - `oauth` object, nullable
          - `enabled` boolean, nullable — Whether OAuth is used to authenticate webhook calls
          - `clientId` string, nullable
          - `clientSecret` string, nullable
          - `audience` string, nullable
          - `scope` string, nullable
          - `tokenUrl` string, nullable
        - `basic` object, nullable — Optional basic-auth configuration for webhooks
          - `enabled` boolean, nullable
          - `username` string, nullable
          - `password` string, nullable
          - `tokenUrl` string, nullable
        - `customHeaders` object, nullable — Extra HTTP headers sent with webhook requests
        - `products` string[], nullable — Which products emit webhooks for this configuration
    - `redirectFinalizePath` string — An optional path that is appended to the tppRedirectUrl in open banking payments. During the finalize step of the payment process, the user will be redirected to this specified path instead of the Open-Finance URL.
    - `includeFakeProviders` boolean — If true, this payment can be used with fake providers
    - `psuIdType` string
    - `providerId` 'yahav-sandbox' | 'yahav' | 'undefined' | 'ubank-sandbox' | 'ubank' | 'pepper' | 'pagi-sandbox' | 'pagi' | 'otsarHahayal-sandbox' | 'otsarHahayal' | 'open-finance-sandbox' | 'open-finance-card-sandbox' | 'mizrahi-sandbox' | 'mizrahi' | 'mercantile-sandbox' | 'mercantile' | 'menora-sandbox' | 'max-sandbox' | 'max' | 'masad-sandbox' | 'masad' | 'leumi-sandbox' | 'leumi' | 'isracard-sandbox' | 'isracard' | 'hapoalim-sandbox' | 'hapoalim' | 'discount-sandbox' | 'discount' | 'cal-sandbox' | 'cal' | 'beinleumi-sandbox' | 'beinleumi' | 'americanExpress', required — A unique identifier for the provider
    - `paymentId` string — If a payment was created before via the create-payment route you can specify its id here
    - `paymentProduct` string
    - `paymentService` 'masav' | 'fp' | 'zahav' — The type of the payment service
    - `externalId` string — An optional id that can be given to a payment
    - `paymentInformation` object, required — The information of the payment
      - `merchantId` string — A unique identifier for the merchant
      - `amount` number, required — The amount of the payment (must be greater than 0)
      - `currency` string, required — The currency of the payment
      - `description` string, required — the description of the payment
      - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
      - `creditorAccountNumber` string — The account number of the creditor. Must be in bban format if creditorAccountType is bban, and in iban format if creditorAccountType is iban. Example of bban: '10-944-50151142'. Example of iban: 'IL123456789012345678901'
      - `debtorId` string — (Optional) debtorId allows the debtor to select his account after authenticating in the bank without providing the account number and type. When provided, debtorAccountNumber and debtorAccountType must NOT be provided (mutually exclusive).
      - `debtorAccountType` 'bban' | 'iban' — The type of the account number of the debtor. Required when debtorId is not provided. Must be omitted when debtorId is provided.
      - `debtorAccountNumber` string — The account number of the debtor. Required when debtorId is not provided. Must be omitted when debtorId is provided. Must be in bban format if debtorAccountType is bban, and in iban format if debtorAccountType is iban. Example of bban: '10-944-50151142'. Example of iban: 'IL123456789012345678901'
      - `creditorName` string — The name of the creditor
      - `debtorName` string — The name of the debtor
      - `requestedExecutionDate` string, date — The date when the future payment should be executed (mutually exclusive with requestedExecutionTime)
      - `requestedExecutionTime` string, date-time — The date-time when the future payment should be executed (mutually exclusive with requestedExecutionDate)
    - `bulkPaymentInformation` object — The information of the bulk payment (only one of paymentInformation, bulkPaymentInformation, or paymentId should be provided)
      - `debtorAccountNumber` string, required — The account number of the debtor
      - `debtorAccountType` 'bban' | 'iban', required — The type of the account number of the debtor
      - `batchBookingPreferred` boolean — If true, the PSU prefers only one booking entry. If false, individual booking of all contained transactions
      - `paymentInformationId` string — Unique identification for this bulk payment
      - `requestedExecutionDate` string, date — The date when the payments should be executed (mutually exclusive with requestedExecutionTime)
      - `requestedExecutionTime` string, date-time — The date-time when the payments should be executed (mutually exclusive with requestedExecutionDate)
      - `payments` object[], required
        - `merchantId` string — A unique identifier for the merchant
        - `amount` number, required — The amount of the payment (must be greater than 0)
        - `currency` string, required — The currency of the payment (must be ILS for bulk payments)
        - `description` string, required — The description of the payment
        - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
        - `creditorAccountNumber` string — The account number of the creditor
        - `creditorName` string — The name of the creditor
    - `periodicPaymentInformation` object — The information for periodic/recurring payments (only one of paymentInformation, bulkPaymentInformation, periodicPaymentInformation, or paymentId should be provided)
      - `merchantId` string — A unique identifier for the merchant
      - `amount` number, required — The amount of each periodic payment
      - `currency` string, required — The currency of the periodic payment
      - `description` string, required — Remittance information for the periodic payment
      - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
      - `creditorAccountNumber` string — The account number of the creditor
      - `creditorName` string — The name of the creditor
      - `debtorAccountNumber` string, required — The account number of the debtor
      - `debtorAccountType` 'bban' | 'iban', required — The type of the account number of the debtor
      - `debtorName` string — The name of the debtor
      - `startDate` string, date, required — The first applicable day of execution
      - `endDate` string, date — The last applicable day of execution (optional, if not provided the standing order is infinite)
      - `frequency` 'Daily' | 'Weekly' | 'EveryTwoWeeks' | 'Monthly' | 'EveryTwoMonths' | 'Quarterly' | 'SemiAnnual' | 'Annual' | 'MonthlyVariable', required — The frequency of the recurring payment
      - `executionRule` 'following' | 'preceding' — Defines behavior when payment date falls on weekend/holiday
      - `dayOfExecution` string — Day of month for execution (1-31, where 31 means ultimo)
      - `monthsOfExecution` string[] — Array of months (1-12) for execution. Only valid when frequency is 'MonthlyVariable'
    - `redirectUrl` string — The URL to which the user will be redirected after the payment is completed
    - `rtpPaymentInformation` object — RTP (Request to Pay) payment information
      - `amount` number, required — Payment amount
      - `currency` 'ILS', required — Payment currency (ILS only)
      - `description` string, required — Payment description
      - `debtorAccountNumber` string, required — Debtor (payer) account number
      - `debtorAccountType` 'iban' | 'bban', required
      - `creditorAccountNumber` string — Creditor account number (optional, uses merchant if not provided)
      - `creditorAccountType` 'iban' | 'bban'
      - `creditorName` string
      - `expiryDateTime` string — RTP expiry in ISO format
      - `requestedExecutionDate` string — Execution date (YYYY-MM-DD)
      - `requestedExecutionDateTime` string — Execution datetime in ISO format. Must be a future date.
  - object
    - `version` '1.8' — API version to use for this request
    - `withEndToEndId` boolean — If true, generates an End-to-End identification for the payment transaction
    - `psuId` string — national id or passport number of the end-user
    - `psuCorporateId` string — The business ID of a customer (business incorporation id)
    - `callbackInformation` CallbackInformation — Webhook and callback configuration stored on the connection (mirrors organization callback shape where applicable)
      - `webhooks` object, nullable
        - `enabled` boolean, nullable — If true, enable webhooks
        - `successUrl` string, nullable — The url endpoint for success events
        - `failUrl` string, nullable — The url endpoint for fail events
        - `abortUrl` string, nullable — The url endpoint for abort events
        - `oauth` object, nullable
          - `enabled` boolean, nullable — Whether OAuth is used to authenticate webhook calls
          - `clientId` string, nullable
          - `clientSecret` string, nullable
          - `audience` string, nullable
          - `scope` string, nullable
          - `tokenUrl` string, nullable
        - `basic` object, nullable — Optional basic-auth configuration for webhooks
          - `enabled` boolean, nullable
          - `username` string, nullable
          - `password` string, nullable
          - `tokenUrl` string, nullable
        - `customHeaders` object, nullable — Extra HTTP headers sent with webhook requests
        - `products` string[], nullable — Which products emit webhooks for this configuration
    - `redirectFinalizePath` string — An optional path that is appended to the tppRedirectUrl in open banking payments. During the finalize step of the payment process, the user will be redirected to this specified path instead of the Open-Finance URL.
    - `includeFakeProviders` boolean — If true, this payment can be used with fake providers
    - `psuIdType` string
    - `providerId` 'yahav-sandbox' | 'yahav' | 'undefined' | 'ubank-sandbox' | 'ubank' | 'pepper' | 'pagi-sandbox' | 'pagi' | 'otsarHahayal-sandbox' | 'otsarHahayal' | 'open-finance-sandbox' | 'open-finance-card-sandbox' | 'mizrahi-sandbox' | 'mizrahi' | 'mercantile-sandbox' | 'mercantile' | 'menora-sandbox' | 'max-sandbox' | 'max' | 'masad-sandbox' | 'masad' | 'leumi-sandbox' | 'leumi' | 'isracard-sandbox' | 'isracard' | 'hapoalim-sandbox' | 'hapoalim' | 'discount-sandbox' | 'discount' | 'cal-sandbox' | 'cal' | 'beinleumi-sandbox' | 'beinleumi' | 'americanExpress', required — A unique identifier for the provider
    - `paymentId` string — If a payment was created before via the create-payment route you can specify its id here
    - `paymentProduct` string
    - `paymentService` 'masav' | 'fp' | 'zahav' — The type of the payment service
    - `externalId` string — An optional id that can be given to a payment
    - `paymentInformation` object — The information of the payment
      - `merchantId` string — A unique identifier for the merchant
      - `amount` number, required — The amount of the payment (must be greater than 0)
      - `currency` string, required — The currency of the payment
      - `description` string, required — the description of the payment
      - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
      - `creditorAccountNumber` string — The account number of the creditor. Must be in bban format if creditorAccountType is bban, and in iban format if creditorAccountType is iban. Example of bban: '10-944-50151142'. Example of iban: 'IL123456789012345678901'
      - `debtorId` string — (Optional) debtorId allows the debtor to select his account after authenticating in the bank without providing the account number and type. When provided, debtorAccountNumber and debtorAccountType must NOT be provided (mutually exclusive).
      - `debtorAccountType` 'bban' | 'iban' — The type of the account number of the debtor. Required when debtorId is not provided. Must be omitted when debtorId is provided.
      - `debtorAccountNumber` string — The account number of the debtor. Required when debtorId is not provided. Must be omitted when debtorId is provided. Must be in bban format if debtorAccountType is bban, and in iban format if debtorAccountType is iban. Example of bban: '10-944-50151142'. Example of iban: 'IL123456789012345678901'
      - `creditorName` string — The name of the creditor
      - `debtorName` string — The name of the debtor
      - `requestedExecutionDate` string, date — The date when the future payment should be executed (mutually exclusive with requestedExecutionTime)
      - `requestedExecutionTime` string, date-time — The date-time when the future payment should be executed (mutually exclusive with requestedExecutionDate)
    - `bulkPaymentInformation` object, required — The information of the bulk payment (only one of paymentInformation, bulkPaymentInformation, or paymentId should be provided)
      - `debtorAccountNumber` string, required — The account number of the debtor
      - `debtorAccountType` 'bban' | 'iban', required — The type of the account number of the debtor
      - `batchBookingPreferred` boolean — If true, the PSU prefers only one booking entry. If false, individual booking of all contained transactions
      - `paymentInformationId` string — Unique identification for this bulk payment
      - `requestedExecutionDate` string, date — The date when the payments should be executed (mutually exclusive with requestedExecutionTime)
      - `requestedExecutionTime` string, date-time — The date-time when the payments should be executed (mutually exclusive with requestedExecutionDate)
      - `payments` object[], required
        - `merchantId` string — A unique identifier for the merchant
        - `amount` number, required — The amount of the payment (must be greater than 0)
        - `currency` string, required — The currency of the payment (must be ILS for bulk payments)
        - `description` string, required — The description of the payment
        - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
        - `creditorAccountNumber` string — The account number of the creditor
        - `creditorName` string — The name of the creditor
    - `periodicPaymentInformation` object — The information for periodic/recurring payments (only one of paymentInformation, bulkPaymentInformation, periodicPaymentInformation, or paymentId should be provided)
      - `merchantId` string — A unique identifier for the merchant
      - `amount` number, required — The amount of each periodic payment
      - `currency` string, required — The currency of the periodic payment
      - `description` string, required — Remittance information for the periodic payment
      - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
      - `creditorAccountNumber` string — The account number of the creditor
      - `creditorName` string — The name of the creditor
      - `debtorAccountNumber` string, required — The account number of the debtor
      - `debtorAccountType` 'bban' | 'iban', required — The type of the account number of the debtor
      - `debtorName` string — The name of the debtor
      - `startDate` string, date, required — The first applicable day of execution
      - `endDate` string, date — The last applicable day of execution (optional, if not provided the standing order is infinite)
      - `frequency` 'Daily' | 'Weekly' | 'EveryTwoWeeks' | 'Monthly' | 'EveryTwoMonths' | 'Quarterly' | 'SemiAnnual' | 'Annual' | 'MonthlyVariable', required — The frequency of the recurring payment
      - `executionRule` 'following' | 'preceding' — Defines behavior when payment date falls on weekend/holiday
      - `dayOfExecution` string — Day of month for execution (1-31, where 31 means ultimo)
      - `monthsOfExecution` string[] — Array of months (1-12) for execution. Only valid when frequency is 'MonthlyVariable'
    - `redirectUrl` string — The URL to which the user will be redirected after the payment is completed
    - `rtpPaymentInformation` object — RTP (Request to Pay) payment information
      - `amount` number, required — Payment amount
      - `currency` 'ILS', required — Payment currency (ILS only)
      - `description` string, required — Payment description
      - `debtorAccountNumber` string, required — Debtor (payer) account number
      - `debtorAccountType` 'iban' | 'bban', required
      - `creditorAccountNumber` string — Creditor account number (optional, uses merchant if not provided)
      - `creditorAccountType` 'iban' | 'bban'
      - `creditorName` string
      - `expiryDateTime` string — RTP expiry in ISO format
      - `requestedExecutionDate` string — Execution date (YYYY-MM-DD)
      - `requestedExecutionDateTime` string — Execution datetime in ISO format. Must be a future date.
  - object
    - `version` '1.8' — API version to use for this request
    - `withEndToEndId` boolean — If true, generates an End-to-End identification for the payment transaction
    - `psuId` string — national id or passport number of the end-user
    - `psuCorporateId` string — The business ID of a customer (business incorporation id)
    - `callbackInformation` CallbackInformation — Webhook and callback configuration stored on the connection (mirrors organization callback shape where applicable)
      - `webhooks` object, nullable
        - `enabled` boolean, nullable — If true, enable webhooks
        - `successUrl` string, nullable — The url endpoint for success events
        - `failUrl` string, nullable — The url endpoint for fail events
        - `abortUrl` string, nullable — The url endpoint for abort events
        - `oauth` object, nullable
          - `enabled` boolean, nullable — Whether OAuth is used to authenticate webhook calls
          - `clientId` string, nullable
          - `clientSecret` string, nullable
          - `audience` string, nullable
          - `scope` string, nullable
          - `tokenUrl` string, nullable
        - `basic` object, nullable — Optional basic-auth configuration for webhooks
          - `enabled` boolean, nullable
          - `username` string, nullable
          - `password` string, nullable
          - `tokenUrl` string, nullable
        - `customHeaders` object, nullable — Extra HTTP headers sent with webhook requests
        - `products` string[], nullable — Which products emit webhooks for this configuration
    - `redirectFinalizePath` string — An optional path that is appended to the tppRedirectUrl in open banking payments. During the finalize step of the payment process, the user will be redirected to this specified path instead of the Open-Finance URL.
    - `includeFakeProviders` boolean — If true, this payment can be used with fake providers
    - `psuIdType` string
    - `providerId` 'yahav-sandbox' | 'yahav' | 'undefined' | 'ubank-sandbox' | 'ubank' | 'pepper' | 'pagi-sandbox' | 'pagi' | 'otsarHahayal-sandbox' | 'otsarHahayal' | 'open-finance-sandbox' | 'open-finance-card-sandbox' | 'mizrahi-sandbox' | 'mizrahi' | 'mercantile-sandbox' | 'mercantile' | 'menora-sandbox' | 'max-sandbox' | 'max' | 'masad-sandbox' | 'masad' | 'leumi-sandbox' | 'leumi' | 'isracard-sandbox' | 'isracard' | 'hapoalim-sandbox' | 'hapoalim' | 'discount-sandbox' | 'discount' | 'cal-sandbox' | 'cal' | 'beinleumi-sandbox' | 'beinleumi' | 'americanExpress', required — A unique identifier for the provider
    - `paymentId` string — If a payment was created before via the create-payment route you can specify its id here
    - `paymentProduct` string
    - `paymentService` 'masav' | 'fp' | 'zahav' — The type of the payment service
    - `externalId` string — An optional id that can be given to a payment
    - `paymentInformation` object — The information of the payment
      - `merchantId` string — A unique identifier for the merchant
      - `amount` number, required — The amount of the payment (must be greater than 0)
      - `currency` string, required — The currency of the payment
      - `description` string, required — the description of the payment
      - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
      - `creditorAccountNumber` string — The account number of the creditor. Must be in bban format if creditorAccountType is bban, and in iban format if creditorAccountType is iban. Example of bban: '10-944-50151142'. Example of iban: 'IL123456789012345678901'
      - `debtorId` string — (Optional) debtorId allows the debtor to select his account after authenticating in the bank without providing the account number and type. When provided, debtorAccountNumber and debtorAccountType must NOT be provided (mutually exclusive).
      - `debtorAccountType` 'bban' | 'iban' — The type of the account number of the debtor. Required when debtorId is not provided. Must be omitted when debtorId is provided.
      - `debtorAccountNumber` string — The account number of the debtor. Required when debtorId is not provided. Must be omitted when debtorId is provided. Must be in bban format if debtorAccountType is bban, and in iban format if debtorAccountType is iban. Example of bban: '10-944-50151142'. Example of iban: 'IL123456789012345678901'
      - `creditorName` string — The name of the creditor
      - `debtorName` string — The name of the debtor
      - `requestedExecutionDate` string, date — The date when the future payment should be executed (mutually exclusive with requestedExecutionTime)
      - `requestedExecutionTime` string, date-time — The date-time when the future payment should be executed (mutually exclusive with requestedExecutionDate)
    - `bulkPaymentInformation` object — The information of the bulk payment (only one of paymentInformation, bulkPaymentInformation, or paymentId should be provided)
      - `debtorAccountNumber` string, required — The account number of the debtor
      - `debtorAccountType` 'bban' | 'iban', required — The type of the account number of the debtor
      - `batchBookingPreferred` boolean — If true, the PSU prefers only one booking entry. If false, individual booking of all contained transactions
      - `paymentInformationId` string — Unique identification for this bulk payment
      - `requestedExecutionDate` string, date — The date when the payments should be executed (mutually exclusive with requestedExecutionTime)
      - `requestedExecutionTime` string, date-time — The date-time when the payments should be executed (mutually exclusive with requestedExecutionDate)
      - `payments` object[], required
        - `merchantId` string — A unique identifier for the merchant
        - `amount` number, required — The amount of the payment (must be greater than 0)
        - `currency` string, required — The currency of the payment (must be ILS for bulk payments)
        - `description` string, required — The description of the payment
        - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
        - `creditorAccountNumber` string — The account number of the creditor
        - `creditorName` string — The name of the creditor
    - `periodicPaymentInformation` object, required — The information for periodic/recurring payments (only one of paymentInformation, bulkPaymentInformation, periodicPaymentInformation, or paymentId should be provided)
      - `merchantId` string — A unique identifier for the merchant
      - `amount` number, required — The amount of each periodic payment
      - `currency` string, required — The currency of the periodic payment
      - `description` string, required — Remittance information for the periodic payment
      - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
      - `creditorAccountNumber` string — The account number of the creditor
      - `creditorName` string — The name of the creditor
      - `debtorAccountNumber` string, required — The account number of the debtor
      - `debtorAccountType` 'bban' | 'iban', required — The type of the account number of the debtor
      - `debtorName` string — The name of the debtor
      - `startDate` string, date, required — The first applicable day of execution
      - `endDate` string, date — The last applicable day of execution (optional, if not provided the standing order is infinite)
      - `frequency` 'Daily' | 'Weekly' | 'EveryTwoWeeks' | 'Monthly' | 'EveryTwoMonths' | 'Quarterly' | 'SemiAnnual' | 'Annual' | 'MonthlyVariable', required — The frequency of the recurring payment
      - `executionRule` 'following' | 'preceding' — Defines behavior when payment date falls on weekend/holiday
      - `dayOfExecution` string — Day of month for execution (1-31, where 31 means ultimo)
      - `monthsOfExecution` string[] — Array of months (1-12) for execution. Only valid when frequency is 'MonthlyVariable'
    - `redirectUrl` string — The URL to which the user will be redirected after the payment is completed
    - `rtpPaymentInformation` object — RTP (Request to Pay) payment information
      - `amount` number, required — Payment amount
      - `currency` 'ILS', required — Payment currency (ILS only)
      - `description` string, required — Payment description
      - `debtorAccountNumber` string, required — Debtor (payer) account number
      - `debtorAccountType` 'iban' | 'bban', required
      - `creditorAccountNumber` string — Creditor account number (optional, uses merchant if not provided)
      - `creditorAccountType` 'iban' | 'bban'
      - `creditorName` string
      - `expiryDateTime` string — RTP expiry in ISO format
      - `requestedExecutionDate` string — Execution date (YYYY-MM-DD)
      - `requestedExecutionDateTime` string — Execution datetime in ISO format. Must be a future date.
  - object
    - `version` '1.8' — API version to use for this request
    - `withEndToEndId` boolean — If true, generates an End-to-End identification for the payment transaction
    - `psuId` string — national id or passport number of the end-user
    - `psuCorporateId` string — The business ID of a customer (business incorporation id)
    - `callbackInformation` CallbackInformation — Webhook and callback configuration stored on the connection (mirrors organization callback shape where applicable)
      - `webhooks` object, nullable
        - `enabled` boolean, nullable — If true, enable webhooks
        - `successUrl` string, nullable — The url endpoint for success events
        - `failUrl` string, nullable — The url endpoint for fail events
        - `abortUrl` string, nullable — The url endpoint for abort events
        - `oauth` object, nullable
          - `enabled` boolean, nullable — Whether OAuth is used to authenticate webhook calls
          - `clientId` string, nullable
          - `clientSecret` string, nullable
          - `audience` string, nullable
          - `scope` string, nullable
          - `tokenUrl` string, nullable
        - `basic` object, nullable — Optional basic-auth configuration for webhooks
          - `enabled` boolean, nullable
          - `username` string, nullable
          - `password` string, nullable
          - `tokenUrl` string, nullable
        - `customHeaders` object, nullable — Extra HTTP headers sent with webhook requests
        - `products` string[], nullable — Which products emit webhooks for this configuration
    - `redirectFinalizePath` string — An optional path that is appended to the tppRedirectUrl in open banking payments. During the finalize step of the payment process, the user will be redirected to this specified path instead of the Open-Finance URL.
    - `includeFakeProviders` boolean — If true, this payment can be used with fake providers
    - `psuIdType` string
    - `providerId` 'yahav-sandbox' | 'yahav' | 'undefined' | 'ubank-sandbox' | 'ubank' | 'pepper' | 'pagi-sandbox' | 'pagi' | 'otsarHahayal-sandbox' | 'otsarHahayal' | 'open-finance-sandbox' | 'open-finance-card-sandbox' | 'mizrahi-sandbox' | 'mizrahi' | 'mercantile-sandbox' | 'mercantile' | 'menora-sandbox' | 'max-sandbox' | 'max' | 'masad-sandbox' | 'masad' | 'leumi-sandbox' | 'leumi' | 'isracard-sandbox' | 'isracard' | 'hapoalim-sandbox' | 'hapoalim' | 'discount-sandbox' | 'discount' | 'cal-sandbox' | 'cal' | 'beinleumi-sandbox' | 'beinleumi' | 'americanExpress', required — A unique identifier for the provider
    - `paymentId` string — If a payment was created before via the create-payment route you can specify its id here
    - `paymentProduct` string
    - `paymentService` 'masav' | 'fp' | 'zahav' — The type of the payment service
    - `externalId` string — An optional id that can be given to a payment
    - `paymentInformation` object — The information of the payment
      - `merchantId` string — A unique identifier for the merchant
      - `amount` number, required — The amount of the payment (must be greater than 0)
      - `currency` string, required — The currency of the payment
      - `description` string, required — the description of the payment
      - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
      - `creditorAccountNumber` string — The account number of the creditor. Must be in bban format if creditorAccountType is bban, and in iban format if creditorAccountType is iban. Example of bban: '10-944-50151142'. Example of iban: 'IL123456789012345678901'
      - `debtorId` string — (Optional) debtorId allows the debtor to select his account after authenticating in the bank without providing the account number and type. When provided, debtorAccountNumber and debtorAccountType must NOT be provided (mutually exclusive).
      - `debtorAccountType` 'bban' | 'iban' — The type of the account number of the debtor. Required when debtorId is not provided. Must be omitted when debtorId is provided.
      - `debtorAccountNumber` string — The account number of the debtor. Required when debtorId is not provided. Must be omitted when debtorId is provided. Must be in bban format if debtorAccountType is bban, and in iban format if debtorAccountType is iban. Example of bban: '10-944-50151142'. Example of iban: 'IL123456789012345678901'
      - `creditorName` string — The name of the creditor
      - `debtorName` string — The name of the debtor
      - `requestedExecutionDate` string, date — The date when the future payment should be executed (mutually exclusive with requestedExecutionTime)
      - `requestedExecutionTime` string, date-time — The date-time when the future payment should be executed (mutually exclusive with requestedExecutionDate)
    - `bulkPaymentInformation` object — The information of the bulk payment (only one of paymentInformation, bulkPaymentInformation, or paymentId should be provided)
      - `debtorAccountNumber` string, required — The account number of the debtor
      - `debtorAccountType` 'bban' | 'iban', required — The type of the account number of the debtor
      - `batchBookingPreferred` boolean — If true, the PSU prefers only one booking entry. If false, individual booking of all contained transactions
      - `paymentInformationId` string — Unique identification for this bulk payment
      - `requestedExecutionDate` string, date — The date when the payments should be executed (mutually exclusive with requestedExecutionTime)
      - `requestedExecutionTime` string, date-time — The date-time when the payments should be executed (mutually exclusive with requestedExecutionDate)
      - `payments` object[], required
        - `merchantId` string — A unique identifier for the merchant
        - `amount` number, required — The amount of the payment (must be greater than 0)
        - `currency` string, required — The currency of the payment (must be ILS for bulk payments)
        - `description` string, required — The description of the payment
        - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
        - `creditorAccountNumber` string — The account number of the creditor
        - `creditorName` string — The name of the creditor
    - `periodicPaymentInformation` object — The information for periodic/recurring payments (only one of paymentInformation, bulkPaymentInformation, periodicPaymentInformation, or paymentId should be provided)
      - `merchantId` string — A unique identifier for the merchant
      - `amount` number, required — The amount of each periodic payment
      - `currency` string, required — The currency of the periodic payment
      - `description` string, required — Remittance information for the periodic payment
      - `creditorAccountType` 'bban' | 'iban' — The type of the account number of the creditor
      - `creditorAccountNumber` string — The account number of the creditor
      - `creditorName` string — The name of the creditor
      - `debtorAccountNumber` string, required — The account number of the debtor
      - `debtorAccountType` 'bban' | 'iban', required — The type of the account number of the debtor
      - `debtorName` string — The name of the debtor
      - `startDate` string, date, required — The first applicable day of execution
      - `endDate` string, date — The last applicable day of execution (optional, if not provided the standing order is infinite)
      - `frequency` 'Daily' | 'Weekly' | 'EveryTwoWeeks' | 'Monthly' | 'EveryTwoMonths' | 'Quarterly' | 'SemiAnnual' | 'Annual' | 'MonthlyVariable', required — The frequency of the recurring payment
      - `executionRule` 'following' | 'preceding' — Defines behavior when payment date falls on weekend/holiday
      - `dayOfExecution` string — Day of month for execution (1-31, where 31 means ultimo)
      - `monthsOfExecution` string[] — Array of months (1-12) for execution. Only valid when frequency is 'MonthlyVariable'
    - `redirectUrl` string — The URL to which the user will be redirected after the payment is completed
    - `rtpPaymentInformation` object, required — RTP (Request to Pay) payment information
      - `amount` number, required — Payment amount
      - `currency` 'ILS', required — Payment currency (ILS only)
      - `description` string, required — Payment description
      - `debtorAccountNumber` string, required — Debtor (payer) account number
      - `debtorAccountType` 'iban' | 'bban', required
      - `creditorAccountNumber` string — Creditor account number (optional, uses merchant if not provided)
      - `creditorAccountType` 'iban' | 'bban'
      - `creditorName` string
      - `expiryDateTime` string — RTP expiry in ISO format
      - `requestedExecutionDate` string — Execution date (YYYY-MM-DD)
      - `requestedExecutionDateTime` string — Execution datetime in ISO format. Must be a future date.

## Response `201`

Payment was initiated successfully

- object
  - `paymentId` string — A unique identifier of the new payment
  - `status` 'ACCC' | 'ACSC' | 'ACSP' | 'ACTC' | 'ACWC' | 'RCVD' | 'RJCT' | 'CANC' | 'ACFC' | 'PATC' | 'PART' | 'PENDING' | 'ERROR' | 'INIT' — The status of the payment
  - `scaOAuth` string — The url forwarding the user to the provider to complete the payment
  - `requestStatus` 'PENDING' | 'RCVD' | 'ACCP' | 'ACWC' | 'RJCT' — RTP request status (only returned for request-to-pay payments)

## Other responses

- `400` — Bad Request - Validation errors, provider issues, account validation failures, or business rule violations.
- `401` — Unauthorized access - Invalid or missing access token
- `403` — Forbidden - Access token missing the required permissions
- `404` — Not found - Payment, provider, or merchant not found, or provider not allowed for payment
- `500` — Internal server error

---

[API](https://skmtc.net/open-finance/apis/auth.md) · [All operations](https://skmtc.net/open-finance/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/open-finance/auth/versions/b4d401b65c3d/schema)