Skip to main content
POST /payment/payments/:paymentId

Payment data​

Provide additional payment data as requested by the payment provider in order to fulfill the payment request.

Path Parameters
    paymentId string required

    The ID of the payment that was initialized (created).

Request Body array required

Adds additional data needed to start the payment process with the provider / bank

  • Array [
    • name PaymentDataItemName required

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

    id string

    Additional id to name if needed (aka multiple INPUT(s) with different id's), can be null or copy of name

    value string required
  • ]
Responses

Default response

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
    statusReason PaymentStatusReason

    Possible values: [user_rejection, insufficient_balance, invalid_credentials, technical]

    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, payment_pointer, password, select, username, input, status]

    id string

    Additional id to name if needed (aka multiple INPUT(s) with different id's), otherwise copy of name

    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

    Value of item if applicable (for instance account IBAN to select), otherwise null

  • ]
    • 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)

    sourceAccount object
    type AccountReferenceType

    Possible values: [iban, payment_pointer]

    account type

    identifier string

    unique identifier of account IBAN account number, payment pointer URL ...

    name string

    account holder or display name

    targetAccount object
    type AccountReferenceType

    Possible values: [iban, payment_pointer]

    account type

    identifier string

    unique identifier of account IBAN account number, payment pointer URL ...

    name string

    account holder or 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.

    feeAmount 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

    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.

Loading...