Body Required

• type string Required

  Transaction type. Allowed values: sale

  Value is sale.

• 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

  Transaction 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]+$.

• paymentMethod string Required

  Method used to process the order. More information in section [1.4 Transaction methods and channels]

• paymentMethodChannel string Required

  Payment channel designation. More information in section [1.4 Transaction methods and channels]

• successReturnUrl string(uri) Required

  Return URL from the external payment page after a successful payment

  Maximum length is 300.

• failureReturnUrl string(uri) Required

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

  Maximum length is 300.

• returnUrl string(uri)

  Default return URL.

  Maximum length is 300.

• clientIp string(ipv4, ipv6) Required

  The payer's real IP address provided in IPv4 or IPv6. Required when providing blikCode.

• 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.

• blikCode integer

  BLIK code value for transactions where the code is provided via API.

  Maximum length is 6.

• distributor string

  Distributor name, allowed value: "shoper".

• 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.

  • 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.

  • 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/payer identifier assigned by the merchant; allowed characters: A-Za-z0-9 and hyphen (0x2D)

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

  • locale string

    Payer locale; determines the language of the e-mail informing that the payment process has started; allowed values: pl, en.

• card object

  Card payment data. (Required for card payments)

  Hide card attributes Show card attributes object

  • firstName string Required

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

    Maximum length is 100.

  • lastName string Required

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

    Maximum length is 100.

  • number string Required

    Card number

    Maximum length is 16.

  • month string Required

    Card expiry - month

    Maximum length is 2.

  • year string Required

    Card expiry - year

    Maximum length is 4.

  • cvv string Required

    Card CVV code

    Maximum length is 4.

• additionalData object

  Payer browser information required when performing card payments with 3DS authorization.