Body Required

• serviceId string(uuid) Required

  Shop 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}$.

• paymentProfileId string(uuid) Required

  Payment profile 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

  The transaction amount in the smallest currency unit, e.g. pennies.

• currency string Required

  Transaction currency in the ISO 4217 standard

  Maximum length is 3. Values are PLN, EUR, USD, GBP, CHF, SEK, HUF, CZK, BGN, or RON.

• orderId string Required

  Order ID

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

• title string

  Transaction title

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

• notificationUrl string(uri)

  Dynamic notification address, possibility to set a specific address for a single transaction. Addresses containing localhost and ports will be rejected.

  Maximum length is 300.

• data object
  Hide data attribute Show data attribute object

  • multipayout array[object] Required

    Information about the account numbers to which the funds from the transaction are to be paid.
    The active multipayout function is required.

    Hide multipayout attributes Show multipayout attributes object

    • ban string Required

      Bank account number

      Minimum length is 26, maximum length is 26. Format should match the following pattern: ^[0-9]{26}$.

    • amount integer Required

      The transaction amount in the smallest currency unit, e.g. pennies.

    • label string Required

      Recipent name

      Maximum length is 70. Format should match the following pattern: ^[A-Za-z0-9\-\,\. \u00C0-\u02C0"']+$.

    • title string

      Transfer title.
      Its presence causes the transaction to be separated in the recipient's account. Specifying a parameter for one element requires it to be provided for the others.

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

• invoice object

  Invoice details required for the active service ING Księgowość and for Split payment.

  Hide invoice attributes Show invoice attributes object

  • buyer object Required

    Buyer data

    Hide buyer attributes Show buyer attributes object

    • type string Required

      Buyer type. Takes the value PERSON individual recipient or COMPANY company

      Values are PERSON or COMPANY.

    • email string(email) Required

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

      Maximum length is 200.

    • fullName string Required

      Buyer's name and surname/company name

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

    • street string Required

      Street

      Maximum length is 200. Format should match the following pattern: ^[0-9a-zA-Z\s\-#.'"&,_/\u00C0-\u02C0]*$`.

    • city string Required

      City

      Maximum length is 100. Format should match the following pattern: ^[0-9a-zA-Z\s\-#.'"&,_/\u00C0-\u02C0]*$`.

    • postalCode string Required

      Postal code

      Maximum length is 30.

    • countryCodeAlpha2 string Required

      Alpha2 country code

      Maximum length is 2.

    • idCountryCodeAlpha2 string

      Country code identifier Alpha2. Required for the VAT_ID value of the idType parameter.

      Maximum length is 2.

    • idType string

      Identification number type. Required for the COMPANY value of the type parameter. Takes the value ID for PESEL or VAT_ID for NIP.

      Values are ID or VAT_ID.

    • idNumber string

      Tax Identification Number or Personal Identification Number. Required for the COMPANY value for the type parameter.

      Maximum length is 30.

  • positions array[object] Required

    List of products

    Hide positions attributes Show positions attributes object

    • name string Required

      Product name

    • code string Required

      Product code

    • quantity number Required

      Quantity. The minimum value is 0.

    • unit string Required

      Unit

    • grossAmount integer Required

      Gross unit value

    • taxStake string Required

      Tax stake

      Values are TAX_23, TAX_22, TAX_8, TAX_7, TAX_5, TAX_3, TAX_0, TAX_EXEMPT, TAX_NOT_LIABLE, TAX_REVERSE_CHARGE, or TAX_EXCLUDING.

    • discountAmount integer

      Discount amount

    • taxAmount integer

      Tax value in pence. Required only for Split Payment.

  • issueInvoice boolean

    Automatic invoice dispatch

  • basisForVatExemption object

    Basis for tax exemption

    Hide basisForVatExemption attributes Show basisForVatExemption attributes object

    • type string Required

      Values are DENTAL_TECHNICAN_SERVICES, DOCTOR_DENTIST_SERVICES, PHYSIOTHERAPY_SERVICES, NURSING_SERVICES, PSYCHOLOGICAL_SERVICES, MEDICAL_TRANSPORT_SERVICES, CARE_SERVICES, TUTORING, TEACHING_FOREIGN_LANGUAGES, ARTISTS, RENTING_PROPERTY, INSURANCE_SERVICES, CREDITS_AND_LOANS_SERVICES, GUARANTIEES, SPECIAL_CONDITIONS_FOR_EXEMPTION, UE_TRANSACTIONS, SUBJECTIVE_EXEMPTIONS, OTHER, or OTHER_OBJECTIVE_EXEMPTIONS.

    • text string

      Description. This parameter is required when the value OTHER is specified in the type parameter.

  • invoiceId string

    Invoice number. Required only for Split Payment.