Initiate a payment

post

https://api.finx-s.qwist.cloud/rest/payments/{payment-id}/init

Initiate a payment by submitting it to the payment service provider. The payment initiation is executed as an asynchronous background operation. The state of this operation can be monitored polling the initiation status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payment-id

string

required

finX ID of the payment.

Body Params

credentials

Credentials used for authentication with the financial service provider.

save_secrets

boolean

Indicates whether the confidential parts of the credentials should be saved for future payment operations. If set to false previously saved secrets are discarded at the end of the payment operation. This can only be used if the payment is initiated with user_auth.

redirect_uri

url

The URI to which the user is redirected at the end of a redirect based authentication flow. The state that has been specified in the request will be attached as a query parameter to the URI.

state

string

required

length between 1 and 1024

An arbitrary string to maintain state between this request and the callback, e.g. it might contain a session ID from your application. The value should also contain a random component, which your application checks to prevent cross-site request forgery.

reuse_auth_method

boolean

Defaults to true

Indicates whether the last selected authentication method should be re-used for this payment initiation. This minimizes the amount of challenges that have to be solved in the course of the payment initiation.

reuse_auth_medium

boolean

Defaults to true

Indicates whether the last selected authentication medium should be re-used for this payment initiation. This minimizes the amount of challenges that have to be solved in the course of the payment initiation.

psu_ip

string

The IP address of the end-user for whom the payment is initiated. This might be required by the provider. It is advised to provide this value whenever possible.

Headers

Content-Type

string

enum

required

The Content-Type entity header is used to indicate the media type of the request.

Allowed:

Responses

201Payment initiation status.

400Bad request.

401You are not authorized.

404The specified resource was not found.