HomeGuidesAPI Reference
Log In
API Reference

Initiate a payment of account

post deprecated
https://api.finx-s.qwist.cloud/rest/accounts//payments//init

Initiate a payment by sending it to the payment service provider. The payment is executed as an asynchronous background operation. The status of this operation can be monitored by polling the payment and and tracking the status field. Deprecated in favour of init payment endpoint.

Path Params
string
required

finX ID of account.

string
required

finX ID of the payment.

Body Params
credentials

Credentials used for authentication with the financial service provider.

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.

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.

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.

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.

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.

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
string
enum
required

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

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Bearer
JWT
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago