Body Required

• serviceId string(uuid) Required

  Store identifier as UUID v4

  Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

• amount integer Required

  Transaction amount in the smallest currency unit, e.g. grosz

• currency string Required

  Transaction currency in ISO 4217 format

  Maximum length is 3. Values are PLN or EUR.

• orderId string Required

  Merchant order number, allowed characters: A-Za-z0-9#_-.\/ plus space (0x20) and UNICODE range 00C0 - 02C0 (incl. Polish diacritics)

  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\/ \u00C0-\u02C0]+$.

• title string

  Order title, allowed characters: A-Za-z0-9#&_-"',./ plus space (0x20) and UNICODE range 00C0 - 02C0 (incl. Polish diacritics).

  Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\/ \u00C0-\u02C0]+$.

• customer object Required
  Hide customer attributes Show customer attributes object

  • firstName string Required

    Customer first name,
    allowed characters: A-Za-z0-9#&_-"',.\/ plus space (0x20) and UNICODE range 00C0 - 02C0 (incl. Polish diacritics), 0400 - 04FF (Cyrillic)

    Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\/ \u00C0-\u02C0\u0400-\u04FF]+$.

  • lastName string Required

    Customer last name,
    allowed characters: A-Za-z0-9#&_-"',.\/ plus space (0x20) and UNICODE range 00C0 - 02C0 (incl. Polish diacritics), 0400 - 04FF (Cyrillic)

    Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.

  • email string(email) Required

    E-mail address in a format compliant with RFC 5322 and RFC 6531

    Maximum length is 200.

  • phone string

    Phone number,
    allowed characters: 0-9+- and space (0x20)

    Maximum length is 20. Format should match the following pattern: ^[0-9\+\- ]+$.

  • cid string

    Customer identifier. (Required for oneclick, recurring payments),
    allowed characters: A-Za-z0-9 and hyphen (0x2D)

    Maximum length is 36. Format should match the following pattern: ^[A-Za-z0-9\x2D]+$.

• returnUrl string(uri)

  Return URL from the external payment page if the transaction status is not resolved

  Maximum length is 300.

• successReturnUrl string(uri)

  Return URL from the external payment page after a successful payment

  Maximum length is 300.

• failureReturnUrl string(uri)

  Return URL from the external payment page in case of a payment error

  Maximum length is 300.

• visibleMethod array

  Visibility of payment methods; by default, all methods available for the store are visible. Description in section 5.3 Payment methods visibility

• paywall.forceCardChannel string

  Force card payment mode. Allows initializing a card payment in profile-saving mode. Available values: ecom3ds, oneclick, recurring. When using oneclick or recurring, customer.cid is required.

• activeTo integer, null

  Transaction expiration date as a Unix timestamp in seconds (seconds since 1970-01-01 UTC) (value must be >= 1 and <= 4294967295). If not provided or null, the transaction is valid indefinitely. Not completing the payment by this time will cancel it.

• distributor string

  Distributor name, allowed value: "shoper".

• surcharge boolean

  Flag determining whether payer charging will be used for the given order. Allowed values: 'true', 'false' (requires surcharge flag enabled during onboarding).