New payment

POST /payment/payments

Starts a new payment. Depending on payment provider additional data will be inquired if needed to gather all needed data to forward payment request to the payment provider.

Query Parameters

locale Locale

Desired language of dialog (if supported). See supported dialog languages for more information.

application/json

Request Body required

Initiates new payment

providerId ProviderId required

Unique payment provider (bank) id

name string required

Possible values: non-empty

Name

description string required

Possible values: non-empty and <= 255 characters

Simple description of transaction.

amount decimal required

Amount of transaction in format: 0.00 without thousand separator, exact to two decimal places. NOTE: If amount is provided with more than two decimal places then amount will be rounded to two decimal paces.

currency CurrencyCode required

ISO 4217 currency code.

data object[]

Additional internal data to be stored alongside payment. This can be internal shopping basked id, customer profile id, or any other information to link payment to an internal process.

Array [

key string

unique key of internally stored data. For instance basked_id, customer_id ...

value string

value of internally stored data.

]

Responses

Newly initiated payment

application/json

Schema

Example (from schema)

Schema

paymentId PaymentId

Unique payment id

status PaymentStatus

Possible values: [initiated, started, pending, rejected, canceled, expired, failed, successful, scheduled, verification_required]

initiated - payment dialog was initiated - started - payment was started but client needs to enter additional data - pending - client is in bank process waiting for confirmation - cancelled - client cancelled payment - rejected - payment was rejected by the provider - expired - process took to long - payment expired - failed - payment was not successful - successful - payment was successful

created date-time

RFC 3339 date time format (2007-11-06T16:34:41.000Z)

modified date-time

RFC 3339 date time format (2007-11-06T16:34:41.000Z)

paymentData object[]

Additional data needed to fulfill payment request, to be provided by end user

Array [

name PaymentDataItemName required

Possible values: [redirect, otp, iban, password, select, username, status]

label string

Label to display to the user to enter or select listed data

additional_data string

Display additional data to the user

properties object[]

Array [

value string

Value of additional data, as it was entered by the user

label string

Label to display to the client in order to enter additional data. This can be IBAN account number, a one-time password or similar.

description string

Description of additional data to be entered. Additional context (not necessary provided)

]

value string

]

providerId ProviderId

Unique payment provider (bank) id

name string

Transaction name. What is the intent of the transaction. Will be visible on customers transaction list (bank transactions).

description string

Additional short description of transaction. Additional context of the transaction intent visible in transaction list on Fliqa platform.

pointOfSaleId PointOfSaleId

Point of sale unique id

sourceIban IBAN

Possible values: >= 15 characters and <= 34 characters

IBAN account number with country prefix

sourceName string

Source account owner name surname or description if available

targetIban IBAN

Possible values: >= 15 characters and <= 34 characters

IBAN account number with country prefix

targetName string

Target account owner name or description (i.e. the Point Of Sale display name)

amount decimal

currency CurrencyCode

ISO 4217 currency code.

country CountryCode

Payment provider country code (ISO 3166 alpha-2 codes)

data object[]

Additional internal data to be stored alongside payment. This can be internal shopping basked id, customer profile id, or any other information to link payment to an internal process.

Array [

key string

unique key of internally stored data. For instance basked_id, customer_id ...

value string

value of internally stored data.

]

locale Locale

Two letter ISO 639-1 language/locale code.

{
  "paymentId": "a683072aeeb746d58aa34dd5537c4aae",
  "status": "initiated",
  "created": "2025-11-18T10:57:31.587Z",
  "modified": "2025-11-18T10:57:31.587Z",
  "paymentData": [
    {
      "name": "iban",
      "value": "RO66BACX0000001234567890"
    },
    {
      "name": "username",
      "value": "tester"
    }
  ],
  "providerId": "string",
  "name": "Account top-up",
  "description": "Account top up: online services",
  "pointOfSaleId": "my-point-of-sale-123",
  "sourceIban": "AT483200000012345865",
  "sourceName": "Janez Novak",
  "targetIban": "AT483200000012345865",
  "targetName": "Super store",
  "amount": 12.3,
  "currency": "EUR",
  "country": "AT",
  "data": [
    {
      "key": "customer_id",
      "value": "external_id_1234"
    }
  ],
  "locale": "en"
}

Invalid parameter, can't fulfill request

application/json

Schema

Example (from schema)

Example

Schema

errorMessage string required

Description of error

errorCode ErrorCode required

Possible values: [invalid_parameter, unauthorized, forbidden, not_found, not_allowed, bad_request, other]

Error code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}

errorSubCode ErrorSubCode

Possible values: [api_key_secret_header_must_be_provided, authorization_header_must_be_provided, domain_not_allowed, access_not_allowed, access_token_expired, invalid_access_scope, not_authorized, phone_or_email_not_registered, phone_number_start_with_plus_and_country, phone_number_invalid, email_invalid, email_or_phone_number_required, invalid_pin, could_not_interpret_numbers_after_plus, supplied_string_not_phone_number, string_supplied_too_short_to_be_phone_number, string_supplied_too_long_to_be_phone_number, string_supplied_was_too_long_to_parse, unspecified]

Error sub code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}#{errorSubCode}

documentationUrl uri

Link to documentation if available, typically https://documentation.fliqa.io/api/errors/{errorCode}

requestId RequestId

Unique request id

resourceId ResourceId

Unique resource id

{
  "errorMessage": "string",
  "errorCode": "unauthorized",
  "errorSubCode": "phone_or_email_not_registered",
  "documentationUrl": "string",
  "requestId": "554099e7d0b648d7b96bc31c148425b8",
  "resourceId": "a683072aeeb746d58aa34dd5537c4aae"
}

{
  "errorCode": "invalid_parameter",
  "errorMessage": "Missing payment 'amount'!",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/invalid_parameter"
}

Unauthorized

application/json

Schema

Example (from schema)

Example

Schema

errorMessage string required

Description of error

errorCode ErrorCode required

Possible values: [invalid_parameter, unauthorized, forbidden, not_found, not_allowed, bad_request, other]

Error code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}

errorSubCode ErrorSubCode

Error sub code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}#{errorSubCode}

documentationUrl uri

Link to documentation if available, typically https://documentation.fliqa.io/api/errors/{errorCode}

requestId RequestId

Unique request id

resourceId ResourceId

Unique resource id

{
  "errorMessage": "string",
  "errorCode": "unauthorized",
  "errorSubCode": "phone_or_email_not_registered",
  "documentationUrl": "string",
  "requestId": "554099e7d0b648d7b96bc31c148425b8",
  "resourceId": "a683072aeeb746d58aa34dd5537c4aae"
}

{
  "errorCode": "unauthorized",
  "errorMessage": "Not authorized",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/unauthorized"
}

New payment​

New payment