Onetime payment

post

https://api.finx-s.qwist.cloud/onetime/payment

Start the flow to issue a onetime payment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

state

string

A client-provided identifier that helps track a specific user's journey through the widget flow. When you initially create the widget session, you can set this value to any string that helps identify the user's context (e.g., a session ID, user ID, or transaction reference). When the user completes their interaction and is redirected back to your redirect_uri, this same state value is returned as a query parameter. This mechanism allows you to securely match the returning user with their original session and maintain context about who they are and what they were doing, particularly important in scenarios with multiple concurrent widget sessions.

redirect_uri

url

required

The URL where users will be redirected after completing their interaction with the Widget.

The redirect includes the following query parameters:

state: Your original state value passed during initialization
success: Boolean indicating whether the flow completed successfully
cancel: Boolean indicating if the user canceled the flow (only present when canceled)
code: Authorization code valid for 1 hour, used to obtain an access token (only present on successful completion)
flow_id: Unique identifier for accessing flow-specific resources

language

string

enum

The display language used in the Widget UI.

Allowed:

payment

object

required

SEPA transfer

provider_id

object

Defaults to null

Optional identifier to pre-select a specific financial provider, bypassing the provider search and selection step. When omitted, users can search and choose their provider through the Widget UI. To obtain valid provider IDs, refer to the catalog endpoint. Note:
When both payment.debtor.iban and provider_id are in the same payload, payment.debtor.iban is given priority for deducing the underlying financial provider.

readout

array of strings

Defaults to

Defines entries that shall be available for a readout after the payment has been initiated. Depending on the values provided the account information and transaction history of the source account can be retrieved. This will implicitly perform an account synchronization and might require additional challenges to be answered in the scope of the Strong Customer Authentication. Note:
For regulated customers an account readout requires you to have a license that includes access rights for Account Information Services.

readout

Responses

201Widget link created

400Bad request.

401You are not authorized.