Initiate a payment with a provider

post

https://api.open-finance.ai/v2/pay/open-banking-init

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

version

string

enum

API version to use for this request

Allowed:

withEndToEndId

boolean

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

psuId

string

length between 5 and 9

^[0-9]+$

national id or passport number of the end-user

psuCorporateId

string

length between 8 and 9

^[0-9]+$

The business ID of a customer (business incorporation id)

callbackInformation

object

Webhook and callback configuration stored on the connection (mirrors organization callback shape where applicable)

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

Defaults to false

If true, this payment can be used with fake providers

psuIdType

string

providerId

string

enum

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

string

enum

The type of the payment service

Allowed:

externalId

string

An optional id that can be given to a payment

paymentInformation

object

The information of the payment

bulkPaymentInformation

object

The information of the bulk payment (only one of paymentInformation, bulkPaymentInformation, or paymentId should be provided)

periodicPaymentInformation

object

The information for periodic/recurring payments (only one of paymentInformation, bulkPaymentInformation, periodicPaymentInformation, or paymentId should be provided)

redirectUrl

string

The URL to which the user will be redirected after the payment is completed

rtpPaymentInformation

object

RTP (Request to Pay) payment information

Responses

403

Forbidden - Access token missing the required permissions

201Payment was initiated successfully

400Bad Request - Validation errors, provider issues, account validation failures, or business rule violations.

401Unauthorized access - Invalid or missing access token

404Not found - Payment, provider, or merchant not found, or provider not allowed for payment

500Internal server error