Skip to main content
GET /service/payments

List of payments

Get payments list

Query Parameters
    createdFrom date-time

    From date time - filtered against created time

    createdUntil date-time

    Util date time - filtered against created time

    providerName string

    Payment provider/bank name

    iban IBAN

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

    Payment source IBAN account number

    country CountryCode

    Payment country code

    status PaymentStatus

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

    amount decimal

    Payment amount (approximate +/- 1.00)

    currency CurrencyCode

    ISO Currency code

    dataKey string

    Payment data key

    dataValue string

    Payment data value

    cursor string
Responses

OK


Schema
    data object[]
  • Array [
  • 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)

    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 string

    Point of Sale to accepting payment (i.e. target account)

    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

    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

    ISO 4217 currency code.

    country CountryCode

    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.

    rating double
  • ]
  • metadata object
    next_cursor string
Loading...