Verify and Pay

post

https://api.finx-s.qwist.cloud/verify-and-pay

Verify and Pay flow can be used in order to pre-define a set of validations which the account selected for the payment needs to be aligned to. These validations, under the umbrella of the verification_rules field, avoid to initiate the payment if they are not matched and block the flow after synchronizing the account.

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

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
failed_rules: Comma separated list of rules which failed in the verification step. Only present on the Verify and Pay flow

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.

verification_rules

object

required

Set of predefined rules for defining the constraints the selected account must match in order to proceed with the regular payment flow. If any of the rules are not properly validated, the entire flow ends with an error message, since the selected account is not considered valid for the payment.

reporting_period

integer

≥ 4

Specifies the amount of months from the current date backwards to use in the report generation. If any report was requested and this field is not specified, the default value is 12.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Widget link created

400Bad request.

401You are not authorized.