API Reference

Create payment

post
https://{API_PREFIX}.open-finance.ai/v2/payments
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

API version to use for this request

Allowed:
boolean

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

string

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

string

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

string

An optional id that can be given to a payment

boolean

If true, this payment can be used with fake providers

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.

string
length between 5 and 9

The national id or passport number of the person paying

string
length between 8 and 9

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

string
providerIds
array of strings
providerIds
boolean
Defaults to false

If true this payment will allow business accounts

boolean
Defaults to false

If true this payment will be only of business type

string
enum

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

Allowed:
string
string
enum

The type of the payment service

Allowed:
boolean

indicates whether the payment journey would be displayed inside an iframe

boolean

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

paymentInformation
object
required

The information of the payment. amount, currency and description are required.

bulkPaymentInformation
object
periodicPaymentInformation
object

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

callbackInformation
object

Information regarding callbacks and webhooks for the payment

Responses

403

Forbidden - Access token missing required permissions

Updated 7 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago