Create payment

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

The creation of a standalone payment is useful in situations where the account and transaction data is not of interest. This endpoint can be used with either user_auth or client_auth, but only in the case of user_auth the login information can be securely saved on the finX platform and can be used for subsequent payment operations.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

account_id

string

finX ID of account.

payment_id

string

finX ID of the payment.

type

string

Type of a payment.

SEPA transfer

debtor

object

Information about the entity (e.g. person, company) the payment originates from.

iban

string

required

The IBAN of the source account.

creditor

object

Information about the entity (e.g. person, company) the payment is directed to.

iban

string

required

The IBAN of the target account.

name

string

required

The name of the recipient.

amount

object

The money amount to be transferred with this payment.

value

number

required

Monetary value.

currency

string

Defaults to EUR

Three-letter currency code.

purpose

string

The purpose of this payment.

sepa_purpose_code

string

SEPA category purpose code classifying the transfer as defined in ISO 20022 (e.g. SALA for salary payment or GDDS for purchase/sale of goods).

end_to_end_reference

string

A reference code that can be used by the creditor for further identification of the transaction (e.g. a customer number or invoice number).

provider

object

The details of the provider associated to the debtor account.

string

finX ID of financial service provider.

name

string

Name of the financial service provider.

icon

object

supported

boolean

Indicates if access to financial source is supported by the finX API.

country

string

Country in which the financial service provider operates.

language

object

Language information of catalog item

group

object

Financial service provider group information.

access_method

object

The details of the access method associated to the debtor account. The access_method.credentials-field shows the required input-fields that have to be provided when initiating the payment.

string

finX ID of the provider access method.

in_psd2_scope

boolean

Indicates whether payment accounts falling into the scope of the PSD2 are accessed via this method.

type

string

Type of the access method. Describes the interface used to access the financial provider.

API: access via PSD2-compliant API (e.g. Berlin Group)
FINTS: access via FinTS protocol (Germany only)
SCRAPING: access via screen scraping
COMBINED: combination of API and SCRAPING (Spain only)

API FINTS SCRAPING COMBINED

supported_account_types

array of strings

supported_account_types

configurable_consent

boolean

Indicates whether consent configuration may be provided

requires_account_identifiers

boolean

Indicates whether account identifiers have to be provided to connect this financial source.

customer_authentication_flows

array of strings

customer_authentication_flows

advice

string

Any advice useful to instruct the user on what data to provide. The language can be selected by sending an appropriate Accept-Language header with the request.

credentials

array of objects

credentials

object

type

string

Defaults to TEXT

Specifies the type of control to render or validation rules to apply. This loosely relates to the types defined for HTML <input>-elements. By default, a TEXT type is assumed, which is rendered as a single-line text field. The SECRET type is similar to a TEXT type, but the field's value is usually obscured. EMAIL fields should apply validation parameters to make sure that the entered text is a valid email address. The DATE type should render a control for entering a date (year, month, and day, with no time). The CHOICE type field is intended for selecting a value from a predefined list of items. These items are provided in the choices property and usually rendered as a dropdown menu.

TEXT EMAIL SECRET DATE CHOICE

key

string

Used as reference for this input field when the entered data is submitted to the finX API.

label

string

Suggested display label. The language can be selected by sending an appropriate Accept-Language header with the request.

min_length

integer

Minimum length entered text.

max_length

integer

Maximum length of entered text.

is_secret

boolean

deprecated

Indicates whether the data entered in the input field is to be considered secret and should be masked. Superseded by the type property set to SECRET.

is_optional

boolean

Indicates whether the input field has to be filled out.

choices

array of objects

Specifies the list of possible values for fields of type CHOICE.

choices

object

label

string

Display text describing the selectable item.

value

string

Value to be sent to the API if the user selected this item.

created_at

string

Entity creation timestamp.

modified_at

string

Entity modification timestamp.

submitted_at

string

Timestamp of submission to the bank server. null if payment has not been submitted yet.

Response body

object

error

object

required

code

integer

required

Code	Group	Description
1000	client	Invalid request
1001	client	Entry already exists
1002	client	Entity not found
1003	client	Unauthorized
1004	client	Invalid client authorization
1005	client	Payment already processed
1006	client	Unprocessable entity
1007	client	Forbidden
1008	client	Resource busy
1010	client	User locked
1011	client	Login credentials are incomplete or malformed
1020	client	Maximum number of account synchronizations exceeded
1021	client	PSU IP is required
10000	user	Login credentials are invalid
10001	user	PIN is invalid
10002	user	Online access is blocked
10003	user	TAN scheme not activated
10004	user	TAN is invalid
10005	user	No authorization for this account
10006	user	Transaction rejected
10007	user	PIN change necessary
10008	user	No authorization for this business transaction
10009	user	HBCI activation necessary
10010	user	Account is blocked
10011	user	Account no longer exists
10012	user	TAN scheme is blocked
10013	user	Status of transaction inconclusive
10014	user	Account not activated for online banking
10015	user	Redundant submissions
10016	user	Invalid OTP
10017	user	Invalid consent configuration
20000	bank	Processing at the bank not possible
20001	bank	Bank / account unknown
20002	bank	Transaction canceled
20003	bank	Maintenance
20004	bank	Technical migration
20005	bank	Transaction not possible
20006	bank	Login not possible
20007	bank	Pop up
30000	general	Processing at finX not possible
30005	general	Task is expired
30006	general	Service temporarily not available
40000	general	Bank not supported
40001	general	Direct access upgrade
40002	general	Multi access upgrade
40003	general	Partial access upgrade

data

object

Additional data.

Has additional fields

description

string

required

Human readable description of the error.

group

string

required

The source of the error.

client user bank general

Language

Credentials

Request


xxxxxxxxxx
1
{
2
  "amount": {
3
    "currency": "EUR"
4
  }
5
}


xxxxxxxxxx
83
}
1
{
2
  "account_id": "A12345.6",
3
  "payment_id": "P12345.6",
4
  "type": "SEPA transfer",
5
  "debtor": {
6
    "iban": "DE93300308800013441006"
7
  },
8
  "creditor": {
9
    "iban": "DE93300308800013441006",
10
    "name": "John Doe"
11
  },
12
  "amount": {
13
    "value": 23.99,
14
    "currency": "EUR"
15
  },
16
  "purpose": "Thanks for all the fish.",
17
  "sepa_purpose_code": "GDDS",
18
  "end_to_end_reference": "5B5U3FFS9EA2LS0O",
19
  "provider": {
20
    "id": "3d3d1133-d0a1-4465-8a83-bb64071f3d48",
21
    "name": "Bank XYZ",
22
    "icon": {
23
      "url": "https://finx-s.finleap.cloud/assets/images/accounts/default.png",
24
      "resolutions": {
25
        "48x48": "https://finx-s.finleap.cloud/assets/images/accounts/default_48.png",

201Payment details.

401You are not authorized.