OPopen-finance

Create payment

post/payments

Request

  • Base URL
    https://api.open-finance.ai/v2
  • URL
    https://api.open-finance.ai/v2/payments
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.open-finance.ai/oauth/token scopes: create:payments

Request body

version'1.8'

API version to use for this request

withEndToEndIdboolean

If true, generates an End-to-End identification for the payment transaction

merchantIdstring

A unique identifier for the merchant, required if orgMerchantId is not configured.

redirectUrlstring

An optional url link to which the user will be redirected after the journey is done. If nothing is set than the url will be taken from the organization settings or the journey will just close

externalIdstring

An optional id that can be given to a payment

includeFakeProvidersboolean

If true, this payment can be used with fake providers

redirectFinalizePathstring

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.

psuIdstring

The national id or passport number of the person paying

psuCorporateIdstring

The ID of a customer (business ID / national ID)

psuIdTypestring
providerIdsstring[]
allowBusinessboolean

If true this payment will allow business accounts

isBusinessboolean

If true this payment will be only of business type

language'he' | 'en'

The language to use in the consent journey, if not set the user will be able to choose the language

paymentProductstring
paymentService'masav' | 'fp' | 'zahav'

The type of the payment service

iframeboolean

indicates whether the payment journey would be displayed inside an iframe

directPayOnlyboolean

Activates Direct Payment method, used to complete a payment without the need of an Open Banking connection

Response

Response

idstring

A unique identifier for the payment

payUrlstring

A link forwarding the end-user to the payment journey

Changes

No recorded changes to this operation across all 1 revision of this API.