{"openapi":"3.0.0","info":{"title":"Przelewy24 REST API Documentation","description":"The widest possible choice of payment methods on the Polish market","version":"0.0.1"},"servers":[{"url":"https:\/\/secure.przelewy24.pl\/api","description":"Przelewy24 REST API Documentation"}],"paths":{"\/v1\/card\/charge":{"post":{"tags":["Card"],"summary":"Asynchronous charge card.","requestBody":{"description":"Input parameters. Card token (card reference id) must be sent in TransactionRegistration process as parameter named 'methodRefId' \/ 'p24_method_ref_id' (depending on the version).","required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardChargeRequestBody"}},"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/CardChargeRequestBody"}}}},"responses":{"200":{"description":"The charge card command has been accepted - notification will be send on success.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ChargeCardSuccessResponse"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/card\/chargeWith3ds":{"post":{"tags":["Card"],"summary":"Synchronously charge card with 3DS check.","requestBody":{"description":"Input parameters - transaction token created through TransactionRegistration proccess with\n    card token (card reference id) sent as parameter named 'methodRefId' \/ 'p24_method_ref_id'\n    (depending on the version).","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardChargeRequestBody"}},"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/CardChargeRequestBody"}}}},"responses":{"200":{"description":"The charge card command has been accepted - notification will be send on success.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ChargeCardSuccessResponse"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/card\/check":{"post":{"tags":["Card"],"summary":"Check card by terminals.","requestBody":{"description":"Input parameters. Card token (card reference id) must be sent in TransactionRegistration process as parameter named 'methodRefId' \/ 'p24_method_ref_id' (depending on the version). Card notification URL must by sent in TransactionRegistration process as parameter named 'urlCardPaymentNotification' \/ 'p24_url_card_payment_notification' (depending on the version).","required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardChargeRequestBody"}},"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/CardChargeRequestBody"}}}},"responses":{"200":{"description":"The check card command has been accepted - notification will be send on success.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CheckCardSuccessResponse"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"Request could not be completed","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Request could not be completed"},"code":{"type":"number","example":409}},"type":"object"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/card\/preauthorization\/{orderId}":{"post":{"tags":["Card"],"summary":"Method commits previous preauthorization.","parameters":[{"name":"orderId","in":"path","description":"An unique order ID.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Request successful.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}},"400":{"description":"Wrong input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}},"403":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Transaction not exists","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]},"delete":{"tags":["Card"],"summary":"Method cancels previous preauthorization.","parameters":[{"name":"orderId","in":"path","description":"An unique order ID.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Request successful.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}},"400":{"description":"Wrong input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}},"403":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Transaction not exists","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/card\/info\/{orderId}":{"get":{"tags":["Card"],"summary":"Method returns information about credit card used in transaction.","parameters":[{"name":"orderId","in":"path","description":"An unique order ID.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Request successful.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetCardInfoResponseData"}}}},"400":{"description":"Wrong input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}},"403":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Transaction not exists","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/card\/insert":{"post":{"tags":["Card"],"summary":"Make card insert.","requestBody":{"description":"Input data format","content":{"application\/json":{"schema":{"required":["transactionToken, cardNumber, cardDate"],"$ref":"#\/components\/schemas\/CardInsertRequestBody"}}}},"responses":{"200":{"description":"The card insert has been succesed.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardInsertSuccessResponse"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardInsertResponse409"}}}}},"callbacks":{"cardPayNotification_positive_authorization":{"urlCardPaymentNotification":{"post":{"requestBody":{"description":"Notification is sent to the url given in the \"urlCardPaymentNotification\" parameter, which must be added to the transaction\/register method, or to a fixed address saved in the P24 account configuration. The value from the token, if it was sent, is paramount.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/cardPayNotificationPositiveAuthorization"}}}},"responses":{"200":{"description":"Your code at urlStatus must return status 200"}}}}},"cardPayNotification_negative_authorization":{"urlCardPaymentNotification":{"post":{"requestBody":{"description":"Notification is sent to the url given in the \"urlCardPaymentNotification\" parameter, which must be added to the transaction\/register method, or to a fixed address saved in the P24 account configuration. The value from the token, if it was sent, is paramount.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/cardPayNotificationNegativeAuthorization"}}}},"responses":{"200":{"description":"Your code at urlStatus must return status 200"}}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/card\/pay":{"post":{"tags":["Card"],"summary":"Make card payment.","requestBody":{"description":"Input data format","required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardRegisterRequestBody"}},"x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/CardRegisterRequestBody"}}}},"responses":{"200":{"description":"The card payment has been succesed.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardPaySuccessResponse"}}}},"201":{"description":"The card payment require 3DS redirection.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardPayThreeDSecureResponse"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardPayResponse409"}}}}},"callbacks":{"cardPayNotification_positive_authorization":{"urlCardPaymentNotification":{"post":{"requestBody":{"description":"Notification is sent to the url given in the \"urlCardPaymentNotification\" parameter, which must be added to the transaction\/register method, or to a fixed address saved in the P24 account configuration. The value from the token, if it was sent, is paramount.","content":{"application\/json":{"schema":{"properties":{"amount":{"type":"integer","example":10,"description":"Transaction amount"},"3ds":{"type":"boolean","example":true,"description":"Was 3D-Secure performed during payment?"},"method":{"type":"integer","example":218,"description":"Payment method ID"},"refId":{"type":"string","example":"10636C17-982F797F-E256FF6A-AED9D667","description":"Card reference number"},"orderId":{"type":"integer","example":300188118,"description":"Transaction number assigned by P24 for oneclick sampling"},"sessionId":{"type":"string","example":"session_1567679496185","description":"Unique identifier from merchant's system"},"bin":{"type":"integer","example":901000,"description":"Registered card bin"},"maskedCCNumber":{"type":"string","example":"xxxxxxxxxxxx0001","description":"Masked card number, format: XXXXXXXXXXXX1234"},"ccExp":{"type":"string","example":"012022","description":"Card expiry date in MMYYYY format eg. 122020"},"hash":{"type":"string","example":"2c73d10720b6bb9bfe9458da1b4c09ac71baaea519ba0f24049ba6f787ab270ce88eb2194642422be20b7f7fbd2a702c","description":"Unique card hash \u2013 unique for each card"},"cardCountry":{"type":"string","example":"PL","description":"Country code compatible with ISO, e.g. PL"},"cardType":{"type":"string","example":"visa","description":"Card type (VISA, ECMC)"},"risk":{"type":"integer","enum":[0,1,2],"description":"0 \u2013 safe, 1 \u2013 suspicious, 2 \u2013 hazardous. Score calculated using a card payment risk calculation tool"},"liabilityshift":{"type":"boolean","example":false,"description":"1 \u2013 Yes, 0 \u2013 No"},"sign":{"type":"string","example":"692b843724c5103d720f26dd1a09148ff9672f104c26aecf95a6d86e01bf9b01a1909f3689093f91640c157bc9fe0cf9","description":"SHA384"}}}}}},"responses":{"200":{"description":"Your code at urlStatus must return status 200"}}}}},"cardPayNotification_negative_authorization":{"urlCardPaymentNotification":{"post":{"requestBody":{"description":"Notification is sent to the url given in the \"urlCardPaymentNotification\" parameter, which must be added to the transaction\/register method, or to a fixed address saved in the P24 account configuration. The value from the token, if it was sent, is paramount.","content":{"application\/json":{"schema":{"properties":{"amount":{"type":"integer","example":10,"description":"Transaction amount"},"3ds":{"type":"boolean","example":true,"description":"Was 3D-Secure performed during payment?"},"method":{"type":"integer","example":218,"description":"Payment method ID"},"refId":{"type":"string","example":"10636C17-982F797F-E256FF6A-AED9D667","description":"Card reference number"},"orderId":{"type":"integer","example":300188118,"description":"Transaction number assigned by P24 for oneclick sampling"},"sessionId":{"type":"string","example":"session_1567679496185","description":"Unique identifier from merchant's system"},"ErrorCode":{"type":"integer","example":"err170","description":"Error code"},"ErrorMessage":{"type":"string","example":"Sth error","description":"Error description"},"sign":{"type":"string","example":"692b843724c5103d720f26dd1a09148ff9672f104c26aecf95a6d86e01bf9b01a1909f3689093f91640c157bc9fe0cf9","description":"SHA384"}}}}}},"responses":{"200":{"description":"Your code at urlStatus must return status 200"}}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/card\/recurringCharge":{"post":{"tags":["Card"],"summary":"Asynchronous recurring charge card.","requestBody":{"description":"Input parameters. Card token (card reference id) must be sent in TransactionRegistration process as parameter named 'methodRefId' \/ 'p24_method_ref_id' (depending on the version).","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardChargeRequestBody"}},"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/CardChargeRequestBody"}}}},"responses":{"200":{"description":"The recurring charge card command has been accepted - notification will be send on success.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ChargeCardSuccessResponse"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/card\/register":{"post":{"tags":["Card"],"summary":"Asynchronous register card.","requestBody":{"description":"Input parameters","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardRegisterRequestBody"}},"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/CardRegisterRequestBody"}}}},"responses":{"200":{"description":"The card registration command has been accepted - the result will be sent in notification.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardRegisterSuccessResponse"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/commission-plans\/offer\/{offerId}":{"get":{"tags":["CommissionPlans"],"summary":"Method returns information about commission plan offer","parameters":[{"name":"offerId","in":"path","description":"An unique offer id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request successful.","content":{"application\/json":{"schema":{"properties":{"data":{"properties":{"offerId":{"type":"string","example":"3c0a1012-1bbc-41c9-bf3e-0c6e6145fcda"},"description":{"type":"string","example":"Offer description"},"note":{"type":"string","example":"Offer note","nullable":true},"afId":{"type":"integer","example":997},"creatorId":{"type":"integer","example":1},"creatorType":{"type":"integer","example":2},"startDate":{"type":"string","example":"2025-06-21 16:36:00"},"apiVersion":{"type":"string","example":"v1"},"endDate":{"type":"string","example":"2025-07-08 16:36:00","nullable":true},"vatId":{"type":"string","example":"PL1231231233"},"commissions":{"properties":{"formGroups":{"properties":{"blik":{"properties":{"defaultConfiguration":{"properties":{"label":{"type":"string","example":"Label"},"surcharge":{"type":"integer","example":"20"},"commission":{"type":"integer","example":"200"},"commissionMin":{"type":"integer","example":"2"},"commissionMax":{"type":"integer","example":"20000"}},"type":"object"},"subgroups":{"properties":{"17":{"properties":{"label":{"type":"string","example":"Label"},"surcharge":{"type":"integer","example":"20"},"commission":{"type":"integer","example":"200"},"commissionMin":{"type":"integer","example":"2"},"commissionMax":{"type":"integer","example":"20000"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"},"fees":{"properties":{"activationFee":{"properties":{"label":{"type":"string","example":"Label"},"fee":{"type":"integer","example":10}},"type":"object"}},"type":"object"},"feesConfig":{"properties":{"commissionMode":{"type":"string","example":"2"},"freeWithdrawalMode":{"type":"string","example":"1"}},"type":"object"}},"type":"object"},"state":{"type":"integer","example":0},"useCounter":{"type":"integer","example":2},"maxUseNumber":{"type":"integer","example":12},"createdAt":{"type":"string","example":"2025-06-20 11:00:52"}},"type":"object"},"code":{"type":"integer","example":"200"}},"type":"object"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Bad request"},"code":{"type":"integer","example":"400"}},"type":"object"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Undefined error"},"code":{"type":"integer","example":"500"}},"type":"object"}}}}},"security":[{"basicAuth":[]}]},"patch":{"tags":["CommissionPlans"],"summary":"Method for Updating an Offer in Commission Plans","parameters":[{"name":"offerId","in":"path","description":"Offer ID","required":true,"schema":{"type":"string","example":"3c0a1012-1bbc-41c9-bf3e-0c6e6145fcda"}}],"requestBody":{"description":"Input parameters","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PatchOfferRequestV1"}}}},"responses":{"200":{"description":"The offer has been updated","content":{"application\/json":{"schema":{"properties":{"data":{"properties":{"offerId":{"type":"string","example":"3c0a1012-1bbc-41c9-bf3e-0c6e6145fcda"},"status":{"type":"string","example":"OK"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/commission-plans\/offers\/{afId}":{"get":{"tags":["CommissionPlans"],"summary":"Get offers data by merchant id","parameters":[{"name":"afId","in":"path","description":"Merchant id.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Current page number.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"The number of resources to return per page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Request successful.","content":{"application\/json":{"schema":{"properties":{"data":{"properties":{"offers":{"type":"array","items":{"properties":{"offerId":{"type":"string","example":"3c0a1012-1bbc-41c9-bf3e-0c6e6145fcda"},"description":{"type":"string","example":"Sample offer description"},"state":{"type":"integer","example":"1"},"createdAt":{"type":"string","example":"2025-06-20 11:00:52"}},"type":"object"}},"totalRecords":{"type":"integer","example":3},"totalPages":{"type":"integer","example":1},"page":{"type":"integer","example":1},"limit":{"type":"integer","example":10}},"type":"object"},"code":{"type":"integer","example":"200"}},"type":"object"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Bad request"},"code":{"type":"integer","example":"400"}},"type":"object"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Unauthorized"},"code":{"type":"integer","example":"401"}},"type":"object"}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Not Found"},"code":{"type":"integer","example":"404"}},"type":"object"}}}},"503":{"description":"Internal error","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Internal error"},"code":{"type":"integer","example":"503"}},"type":"object"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/commission-plans\/offer":{"post":{"tags":["CommissionPlans"],"summary":"Method for Creating an Offer in Commission Plans","requestBody":{"description":"Input parameters","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CreateOfferRequestV1"}}}},"responses":{"201":{"description":"The offer has been created","content":{"application\/json":{"schema":{"properties":{"data":{"properties":{"offerId":{"type":"string","example":"3c0a1012-1bbc-41c9-bf3e-0c6e6145fcda"},"description":{"type":"string","example":"Offer description"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/exchange\/getRate\/{amount}\/{from}\/{to}":{"get":{"tags":["Exchange"],"summary":"Retrieve current EUR -> PLN exchange rate for given merchant.","parameters":[{"name":"amount","in":"path","description":"Amount in EUR","required":true,"schema":{"type":"integer"}},{"name":"from","in":"path","description":"Currency code to exchange from","required":true,"schema":{"type":"string"}},{"name":"to","in":"path","description":"Currency code to exchange to","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetExchangeRateResponse"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ForbiddenResponse"}}}},"500":{"description":"Undefined Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/issueWithdrawal":{"post":{"tags":["Withdraw"],"summary":"Set withdraw.","requestBody":{"description":"Input data format","content":{"application\/x-www-form-urlencoded":{"schema":{"required":["currency"],"properties":{"currency":{"description":"currency","type":"string"},"timestamp":{"description":"timestamp","type":"integer"},"requestId":{"description":"requestId","type":"string"}},"type":"object"}}}},"responses":{"202":{"description":"Successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/merchant\/exists\/{identificationType}\/{identificationNumber}":{"get":{"tags":["Merchant"],"summary":"Checking if the merchant is registered by the partner.","parameters":[{"name":"identificationType","in":"path","description":"nip or pesel type","required":true,"schema":{"type":"string"}},{"name":"identificationNumber","in":"path","description":"nip or pesel value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MerchantExistResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}},"403":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/merchant\/checkIfNipExistsInP24\/{nip}":{"get":{"tags":["Merchant"],"summary":"Check if NIP exists in P24 database.","parameters":[{"name":"nip","in":"path","description":"nip","required":true,"schema":{"type":"string","maxLength":10,"minLength":10,"example":"7792369887"}}],"responses":{"200":{"description":"Successfullu check if nip exists in P24 dataase","content":{"application\/json":{"schema":{"properties":{"result":{"type":"boolean","example":"true"},"code":{"type":"integer","example":"200"}},"type":"object"}}}},"400":{"description":"bad request - invalid NIP","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Invalid NIP"},"code":{"type":"integer","example":"400"}},"type":"object"}}}},"403":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"Can not process this query. Contact with partner support required","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Can not process for this value. Please contact the partner support."},"code":{"type":"integer","example":409}},"type":"object"}}}},"429":{"description":"Daily requests exceeded","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Requests limit for 24h exceeded"},"code":{"type":"integer","example":"429"}},"type":"object"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/merchant\/register":{"post":{"tags":["Merchant"],"summary":"Method create an account and receive a link to confirm the terms of the agreement with the merchant.","requestBody":{"description":"Input data format","content":{"application\/x-www-form-urlencoded":{"schema":{"required":["business_type","name","email","phone_number","bank_account","representatives[name]","representatives[pesel]","contact_person[name]","contact_person[email]","contact_person[phone_number]","address[country]","address[city]","address[post_code]","address[street]","correspondence_address[country]","correspondence_address[city]","correspondence_address[post_code]","correspondence_address[street]","technical_contact[name]","technical_contact[email]","technical_contact[phone_number]","invoice_email","services_description","trade","acceptance","pesel"],"properties":{"business_type":{"description":"Type of business *","type":"integer","enum":["1","2","3","4","5","6","7","8","9","10"]},"name":{"description":"First name and surname of Customer","type":"string"},"email":{"description":"Customer\u2019s email","type":"string"},"phone_number":{"description":"Customer\u2019s telephone number in the following format: 481321132123","type":"string"},"bank_account":{"description":"Bank account number","type":"string"},"representatives[name]":{"description":"Representative authorized to conclude contracts *","type":"string"},"representatives[pesel]":{"description":"Representative social security number","type":"string"},"contact_person[name]":{"description":"Contact person name","type":"string"},"contact_person[email]":{"description":"Contact person email","type":"string"},"contact_person[phone_number]":{"description":"Contact person phone number","type":"string"},"address[country]":{"description":"Customer\u2019s country","type":"string"},"address[city]":{"description":"Customer\u2019s cit","type":"string"},"address[post_code]":{"description":"Customer\u2019s ZIP code","type":"string"},"address[street]":{"description":"Customer\u2019s street","type":"string"},"correspondence_address[country]":{"description":"Correspondence address - country","type":"string"},"correspondence_address[city]":{"description":"Correspondence address - city","type":"string"},"correspondence_address[post_code]":{"description":"Correspondence address - post code","type":"string"},"correspondence_address[street]":{"description":"Correspondence address - street","type":"string"},"technical_contact[name]":{"description":"Technical contact person name","type":"string"},"technical_contact[email]":{"description":"Technical contact person email","type":"string"},"technical_contact[phone_number]":{"description":"Technical contact person phone number","type":"string"},"invoice_email":{"description":"E-mail address for invoices","type":"string"},"shop_url":{"type":"string"},"services_description":{"description":"Description of the service, if the customer does not have a website","type":"string"},"trade":{"description":"Industry suitable for the customer's business *","type":"string"},"acceptance":{"description":"Merchant is obliged to accept the terms and conditions","type":"string"},"nip":{"type":"string"},"regon":{"type":"string"},"krs":{"type":"string"},"pesel":{"description":"Client social security number","type":"string"}},"type":"object"}}}},"responses":{"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MerchantRegistrationResponse"}}}},"500":{"description":"internal error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MerchantRegistrationResponse"}}}},"403":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MerchantRegistrationResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/payment\/methods\/{lang}":{"get":{"tags":["Payment"],"summary":"Method returns a list of payment methods.","parameters":[{"name":"lang","in":"path","description":"A language code. One of these: pl , en","required":true,"schema":{"type":"string","enum":["pl","en"]}}],"responses":{"200":{"description":"List of payment methods"},"403":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Payment methods not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/testAccess":{"get":{"tags":["Info"],"summary":"Method allows to test if access data are correct.","responses":{"200":{"description":"Access data are correct.","content":{"application\/json":{"schema":{"properties":{"data":{"type":"boolean"},"error":{"type":"string"}},"type":"object"}}}},"403":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/by\/sessionId\/{sessionId}":{"get":{"tags":["Transaction"],"summary":"Method returns an information about transaction.","parameters":[{"name":"sessionId","in":"path","description":"Session id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Transaction has been found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionBySessionIdSuccessResponse"}}}},"403":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Transaction not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transactions\/by\/batch\/{batch}":{"get":{"tags":["Transaction"],"summary":"Method returns a list of transactions transferred to Merchant in a single batch.","parameters":[{"name":"batch","in":"path","description":"An unique batch ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transactions has been found","content":{"application\/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/TransactionAbstractResponse"}},"error":{"type":"string","default":""}},"type":"object"}}}},"403":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Transactions not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transactions\/funds\/{orderId}\/{sessionId}":{"get":{"tags":["Transaction"],"summary":"Returns the remaining amount available for refund for the transaction.","parameters":[{"name":"orderId","in":"path","description":"Order identifier","required":true,"schema":{"type":"integer"}},{"name":"sessionId","in":"path","description":"Transaction session identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success \u2013 returned amount available for refund","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionFundsSuccessResponse"}}}},"400":{"description":"Invalid input parameters","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Invalid input parameters"}},"type":"object"}}}},"403":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Transaction not found","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Transaction not found"}},"type":"object"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/merchant\/configuration\/{spId}":{"get":{"tags":["Merchant"],"summary":"Get configuration for merchant.","parameters":[{"name":"spId","in":"path","required":true,"schema":{"description":"merchant id","type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MerchantConfigurationV10Response"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Not found.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MerchantConfigurationV10NotFoundResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/multiStore\/ipAddress":{"get":{"tags":["MultiStore"],"summary":"The ability to get allowed ip addresses for affiliates.","responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetMultiStoreIpAddressesResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}},"403":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/multiStore\/ipAddress\/{affiliate_id}":{"post":{"tags":["MultiStore"],"summary":"The ability to update allowed ip addresses for affiliates.","parameters":[{"name":"affiliate_id","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Input data format","required":false,"content":{"application\/json":{"schema":{"type":"object","$ref":"#\/components\/schemas\/MultiStoreUpdateIpAddressesParameters"}}}},"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetMultiStoreIpAddressesResponse"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/multiStore\/{affiliate_id}\/crc":{"get":{"tags":["MultiStore"],"summary":"The ability to download data CRC merchant in order to create demand transactions on his account.","parameters":[{"name":"affiliate_id","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetAffiliateCrcResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}},"403":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/multiStore\/{affiliate_id}\/apiKey":{"get":{"tags":["MultiStore"],"summary":"The ability to download  merchant's affiliate api key.","parameters":[{"name":"affiliate_id","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetAffiliateApiKeyResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiKeyErrorResponse"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"affiliate not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiKeyErrorResponse"}}}},"422":{"description":"unprocessable entity","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiKeyErrorResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/multiStore\/affiliates":{"get":{"tags":["MultiStore"],"summary":"Ability to get all merchant affiliates or the selected one.","parameters":[{"name":"affiliateId","in":"query","description":"Affiliate ID","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetAffiliatesSuccessResponse"}}}},"400":{"description":"Invalid merchant or affiliate id","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Affiliates not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetAffiliatesNotFoundResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetAffiliatesUnprocessableEntityResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/multiStore\/funds":{"get":{"tags":["MultiStore"],"summary":"Ability to get funds of the merchant.","parameters":[{"name":"merchantId","in":"query","description":"Merchant ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetMerchantFundsResponse"}}}},"400":{"description":"Invalid merchant id","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"403":{"description":"You do not have rights to this account","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/multiStore\/refund":{"post":{"tags":["MultiStore"],"summary":"Create refund for one or more transactions.","requestBody":{"description":"Parameter 'refunds' may contain multiple refunds.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRefundJsonRequestBody"}},"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/TransactionRefundJsonRequestBody"}}}},"responses":{"200":{"description":"Request has been processed successful. Parameter 'data' contains all refunds.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRefund200"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"Parameter 'error' contains all refunds and information about error reason for the wrong ones.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRefund409"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/multiStore\/fee":{"patch":{"tags":["MultiStore"],"summary":"Fee config","description":"Fee config for sub merchant","requestBody":{"required":true,"content":{"application\/json":{"schema":{"properties":{"spId":{"type":"integer","example":1604},"commissions":{"properties":{"formGroups":{"properties":{"blik":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"subgroups":{"properties":{"installment":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190}},"type":"object"}},"type":"object"}},"type":"object"},"pbl":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190}},"type":"object"},"pis":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190}},"type":"object"},"etransfer":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190}},"type":"object"},"cardPayment":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190}},"type":"object"},"installment":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190}},"type":"object"},"deferredPayment":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190}},"type":"object"},"wallet":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190}},"type":"object"},"split":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190}},"type":"object"},"foreign":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190}},"type":"object"}},"type":"object"}},"type":"object"},"fees":{"properties":{"activationFee":{"properties":{"label":{"type":"string","example":"Activation fee"},"fee":{"type":"integer","example":1}},"type":"object"},"withdrawals":{"properties":{"label":{"type":"string","example":"Withdrawal fee"},"fee":{"type":"integer","example":1}},"type":"object"},"freeWithdrawalMode":{"type":"integer","example":0},"foreignIbanWithdrawals":{"properties":{"label":{"type":"string","example":"Foreign IBAN withdrawal fee"},"fee":{"type":"integer","example":1}},"type":"object"},"sepaWithdrawals":{"properties":{"label":{"type":"string","example":"SEPA withdrawal fee"},"fee":{"type":"integer","example":1}},"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"successful operation"},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Commission for blik is 501 and it must by between 0 and 500"},"code":{"type":"integer","example":400}},"type":"object"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"Wrong configuration on server side","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Configuration error"},"code":{"type":"integer","example":409}},"type":"object"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/multiStore\/fee\/{spId}":{"get":{"tags":["MultiStore"],"summary":"Fee config","description":"Get fee config for sub merchant","parameters":[{"name":"spId","in":"path","description":"Sp ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"properties":{"spId":{"type":"integer","example":1604},"commissions":{"properties":{"formGroups":{"properties":{"blik":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"error":{"type":"boolean","example":"false"},"subgroups":{"properties":{"installment":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"error":{"type":"boolean","example":"false"}},"type":"object"}},"type":"object"}},"type":"object"},"pbl":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"error":{"type":"boolean","example":"false"}},"type":"object"},"pis":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"error":{"type":"boolean","example":"false"}},"type":"object"},"etransfer":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"error":{"type":"boolean","example":"false"}},"type":"object"},"cardPayment":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"error":{"type":"boolean","example":"false"}},"type":"object"},"installment":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"error":{"type":"boolean","example":"false"}},"type":"object"},"deferredPayment":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"error":{"type":"boolean","example":"false"}},"type":"object"},"wallet":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"error":{"type":"boolean","example":"false"}},"type":"object"},"split":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"error":{"type":"boolean","example":"false"}},"type":"object"},"foreign":{"properties":{"commission":{"type":"integer","maximum":500,"minimum":0,"example":190},"error":{"type":"boolean","example":"false"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string"},"code":{"type":"integer","example":400}},"type":"object"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/multiStore\/dispatchInfo\/{orderId}":{"get":{"tags":["MultiStore"],"summary":"Method returns an information about transaction.","parameters":[{"name":"orderId","in":"path","description":"transaction id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction has been found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionDispatchItemsResponse"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Transaction not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionNotFoundResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/multiStore\/dispatchTransaction":{"post":{"tags":["MultiStore"],"summary":"Split transaction into multiple mall accounts.","requestBody":{"description":"<b>Required<\/b> array containing dispatch information<br><br>\n                              <b>orderId<\/b> - transaction id to split<br>\n                              <b>sessionId<\/b> - session id of the transaction<br>\n                              <b>sellerId<\/b> - seller id to dispatch the payment to<br>\n                              <b>amount<\/b> - amount dispatched to seller<br>\n                              <b>items<\/b> - optional array of items in the dispatched transaction","required":false,"content":{"application\/x-www-form-urlencoded":{"schema":{"properties":{"dispatchTransactionV1":{"$ref":"#\/components\/schemas\/DispatchDetailsParameters"}},"type":"object"}}}},"responses":{"200":{"description":"Successful","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DispatchSucceedResponse"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DispatchErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ForbiddenResponse"}}}},"500":{"description":"Undefined Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/paymentMethod\/blik\/chargeByCode":{"post":{"tags":["PaymentMethod"],"summary":"Allows to charge blik transaction by T6 code. Returns unique transaction Id","requestBody":{"description":"Input data format","required":false,"content":{"application\/json":{"schema":{"type":"object","$ref":"#\/components\/schemas\/ChargeByCodeParameters"}}}},"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BlikChargeByCodeResponse"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ForbiddenResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/paymentMethod\/blik\/chargeByAlias":{"post":{"tags":["PaymentMethod"],"summary":"Allows to charge blik transaction by alias. Returns unique transaction Id","requestBody":{"description":"Input data format","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ChargeByAliasParameters"}}}},"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BlikChargeByAliasResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ForbiddenResponse"}}}},"409":{"description":"alternativeKeys","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ChargeByAlias409"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"callbacks":{"blikChargeByAliasAdditionalNotification":{"urlCardPaymentNotification":{"post":{"requestBody":{"description":"Notification is sent to the url given in the \"urlCardPaymentNotification\" parameter, which must be added to the transaction\/register method, or to a fixed address saved in the P24 account configuration. The value from the token, if it was sent, is paramount.","content":{"application\/json":{"schema":{"properties":{"data":{"type":"object","properties":{"orderId":{"type":"integer","example":303457712,"description":"Order ID"},"sessionId":{"type":"string","example":"session_1381580057776","description":"Merchant session ID"},"method":{"type":"integer","example":181,"description":"Payment Method ID"},"result":{"type":"object","properties":{"error":{"type":"string","example":"0","description":"Error code - 0 for success"},"message":{"type":"string","example":"Correct Transaction","description":"Error message"},"status":{"type":"string","example":"AUTHORIZED","description":"Transaction status"},"trxRef":{"type":"string","example":"4913521230","description":"BLIK transaction reference number"}}},"sign":{"type":"string","example":"443a049ab03a0cc89e3d131988d2201ff726d070fc39c2bc67a2008847e91f71dcdf03e428692178e1de974c5ecc19bb","description":"Checksum sha384 of parameters: ({\"orderId\":int,\"sessionId\":string,\"method\":int,\"result\":\"array\",\"crc\":\"string\"})"}}}}}}}},"responses":{"200":{"description":"Your code at urlStatus must return status 200"}}}}},"blikChargeByAliasUpdateNotification":{"The address is configured via the P24 service":{"post":{"requestBody":{"description":"Additional notification may be sent to the specified URL, if the alias status is created or changed. The address is configured via the P24 service. The notification can be used as an alternative to the getAliasesByEmail method.","content":{"application\/json":{"schema":{"properties":{"email":{"type":"string","example":"john.doe@example.com","description":"client email"},"value":{"type":"string","example":"Alias","description":"alias value"},"type":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000","description":"UID for oneclick, PAYID for recurring payments"},"status":{"type":"string","enum":["NOT_CONFIRMED","REGISTERED","UNREGISTERED","EXPIRED"]}}}}}},"responses":{"200":{"description":"Your code at urlStatus must return status 200"}}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/paymentMethod\/blik\/getAliasesByEmail\/{email}":{"get":{"tags":["PaymentMethod"],"summary":"Method returns an information about standard client aliases.","parameters":[{"name":"email","in":"path","description":"client email address","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Aliases have been found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetAliasesByEmailResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Aliases not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionNotFoundResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/paymentMethod\/blik\/getAliasesByEmail\/{email}\/custom":{"get":{"tags":["PaymentMethod"],"summary":"Method returns an information about custom client aliases.","parameters":[{"name":"email","in":"path","description":"client email address","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Aliases have been found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetAliasesByEmailResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Aliases not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionNotFoundResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/report\/batch\/details":{"get":{"tags":["Report"],"summary":"Method returns all transactions and refunds paid in requested batch","parameters":[{"name":"batch","in":"query","description":"ID of batch to return data for","required":true,"schema":{"type":"integer"}},{"name":"token","in":"query","description":"Token returned in last request with page of data","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Report was successfully generated","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ReportBatchDetailsResponse"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/report\/batch\/mrx":{"get":{"tags":["Report"],"summary":"Returns list of MRX batches for merchant","responses":{"200":{"description":"List of MRX batches","content":{"application\/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/BatchMrxItem"}},"error":{"type":"string","example":""},"responseCode":{"type":"integer","example":0}},"type":"object"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Bad Request"},"code":{"type":"integer","example":400}},"type":"object"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/report\/batch\/mrx\/{batchId}":{"get":{"tags":["Report"],"summary":"Returns details of specific MRX batch including transactions and refunds","parameters":[{"name":"batchId","in":"path","description":"Batch ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Batch details with transactions and refunds","content":{"application\/json":{"schema":{"properties":{"data":{"properties":{"transactions":{"type":"array","items":{"$ref":"#\/components\/schemas\/BatchMrxTransactionItem"}},"refunds":{"type":"array","items":{"$ref":"#\/components\/schemas\/BatchMrxRefundItem"}}},"type":"object"},"error":{"type":"string","example":""},"responseCode":{"type":"integer","example":0}},"type":"object"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ForbiddenResponse"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Conflict"},"code":{"type":"integer","example":409}},"type":"object"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/report\/batch\/mrx\/{batchId}\/reference":{"get":{"tags":["Report"],"summary":"Returns reference number for specific MRX batch","parameters":[{"name":"batchId","in":"path","description":"Batch ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Batch reference number","content":{"application\/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/BatchMrxItem"}},"error":{"type":"string","example":""},"responseCode":{"type":"integer","example":0}},"type":"object"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Bad Request"},"code":{"type":"integer","example":400}},"type":"object"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ForbiddenResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/report\/history":{"get":{"tags":["Report"],"summary":"Method returns history of transactions, batches or refunds in given period of time","parameters":[{"name":"dateFrom","in":"query","description":"Period start","required":true,"schema":{"type":"string","format":"YYYYMMDD"}},{"name":"dateTo","in":"query","description":"Period end. Max period length is 31 days.","required":true,"schema":{"type":"string","format":"YYYYMMDD"}},{"name":"type","in":"query","description":"Type of objects to load. Omit this parameter, if you want to load everything.","schema":{"type":"string","enum":["transaction","batch","refund"]}}],"responses":{"200":{"description":"Report data generated","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ReportHistoryResponse"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Invalid data provided"},"code":{"type":"integer","example":400},"validation":{"description":"Optional validation errors details","type":"array","items":{"type":"string"}}},"type":"object"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Undefined error"},"code":{"type":"integer","example":500}},"type":"object"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/report\/history\/{token}":{"get":{"tags":["Report"],"summary":"Returns next page in query started with \/v1\/report\/history ","parameters":[{"name":"token","in":"path","description":"Token returned in last request with page of data","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Next page was successfully generated","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ReportHistoryResponse"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Search context for given token not found"},"code":{"type":"integer","example":400}},"type":"object"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"properties":{"error":{"type":"string","example":"Internal service error"},"code":{"type":"integer","example":500}},"type":"object"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/":{"get":{"tags":["Info"],"summary":"Returns API description in JSON","responses":{"200":{"description":"successful operation"}}}},"\/v1\/transaction\/doPayment":{"post":{"tags":["Transaction"],"summary":"Do payment by request id and token","requestBody":{"content":{"application\/json":{"schema":{"properties":{"requestId":{"description":"Request id"},"token":{"description":"Token"}},"type":"object"}}}},"responses":{"200":{"description":"Request successful.","content":{"application\/json":{"schema":{"properties":{"token":{"type":"string"},"sessionId":{"type":"string"},"status":{"type":"string","default":"DONE"},"data":{"properties":{"url":{"type":"string","example":""},"type":{"type":"string","example":"GET"},"payload":{"type":"object","example":[]},"headers":{"properties":{"Content-type":{"type":"string","example":"text\/html; charset=UTF-8"}},"type":"object","nullable":true}},"type":"object","example":[]}},"type":"object"}}}},"201":{"description":"Request successful.","content":{"application\/json":{"schema":{"properties":{"token":{"type":"string"},"sessionId":{"type":"string"},"status":{"type":"string","default":"DONE"},"data":{"properties":{"url":{"type":"string","example":""},"type":{"type":"string","example":"GET"},"payload":{"type":"object","example":[]},"headers":{"properties":{"Content-type":{"type":"string","example":"text\/html; charset=UTF-8"}},"type":"object","nullable":true}},"type":"object","example":[]}},"type":"object"}}}},"400":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/marketplace\/transaction\/by\/sessionId\/{sessionId}":{"get":{"tags":["Transaction"],"summary":"Method returns an information about transaction.","parameters":[{"name":"sessionId","in":"path","description":"Session id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Transaction has been found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionBySessionIdSuccessResponse"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Transaction not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionNotFoundResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/status\/{p24code}":{"get":{"tags":["Transaction"],"summary":"Get transaction status (no language)","parameters":[{"name":"p24code","in":"path","description":"Transaction P24 code in format P24-XXX-XXX-XXX","required":true,"schema":{"type":"string","pattern":"^P24-[\\w-]{3}-[\\w-]{3}-[\\w-]{3}$"},"example":"P24-abc-def-ghi"}],"responses":{"200":{"description":"Transaction status response success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetTransactionStatusResponseSuccess"}}}},"404":{"description":"Transaction status response not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetTransactionStatusResponseNotFound"}}}},"409":{"description":"Transaction status response conflict","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetTransactionStatusResponseConflict"}}}}}}},"\/v1\/transaction\/status\/{p24code}\/{lang}":{"get":{"tags":["Transaction"],"summary":"Get transaction status (with language)","parameters":[{"name":"p24code","in":"path","description":"Transaction P24 code in format P24-XXX-XXX-XXX","required":true,"schema":{"type":"string","pattern":"^P24-[\\w-]{3}-[\\w-]{3}-[\\w-]{3}$"},"example":"P24-abc-def-ghi"},{"name":"lang","in":"path","description":"Language code (1 or 2 characters)","required":true,"schema":{"type":"string","pattern":"^\\w{1,2}$"},"example":"pl"}],"responses":{"200":{"description":"Transaction status response success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetTransactionStatusResponseSuccess"}}}},"404":{"description":"Transaction status response not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetTransactionStatusResponseNotFound"}}}},"409":{"description":"Transaction status response conflict","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetTransactionStatusResponseConflict"}}}}}}},"\/v1\/transactions\/by\/date\/{date}":{"get":{"tags":["Transaction"],"summary":"Method returns a list of transactions made on given date.","parameters":[{"name":"date","in":"path","description":"Date in format: YYYYMMDD ","required":true,"schema":{"type":"string"}},{"name":"X-Scroll-Token","in":"header","description":"Elasticsearch scroll id","required":false,"schema":{"type":"string"}},{"name":"X-Pagination-Per-Page","in":"header","description":"Page size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transactions has been found","content":{"application\/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/TransactionAbstractResponse"}},"error":{"type":"string","default":""}},"type":"object"}}}},"403":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Transactions not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BasicResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/verifyLocation\/{orderId}":{"get":{"tags":["Transaction"],"summary":"Method return information about localization and bank (country in ISO).","parameters":[{"name":"orderId","in":"path","description":"An unique order ID.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InfoResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/payer\/{sessionId}":{"get":{"tags":["Transaction"],"summary":"Method returns information about transaction payer.","parameters":[{"name":"sessionId","in":"path","description":"Session id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Payer data has been found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetPayerInfoExtendedSuccessResponse"}}}},"202":{"description":"The request has been accepted for processing, but the processing has not been completed. The resource will be returned when it becomes available.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetPayerInfoExtendedAcceptedResponse"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Payer data not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetPayerInfoExtendedNotFoundResponse"}}}},"400":{"description":"Invalid payer data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetPayerInfoExtendedInvalidDataResponse"}}}},"409":{"description":"Unable to continue notification process","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetPayerInfoExtendedConflictResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/refund\/by\/orderId\/{orderId}":{"get":{"tags":["Refunds"],"summary":"Get refund details for given Order Id","parameters":[{"name":"orderId","in":"path","description":"existing refund Order Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Request has been processed successful. Parameter 'data' contains refund info.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRefundsInfoResponse"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Refund with given Order Id not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionNotFoundResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/marketplace\/transaction\/refund":{"post":{"tags":["Transaction"],"summary":"Create refund for one or more transactions.","requestBody":{"description":"Parameter 'refunds' may contain multiple refunds.","content":{"application\/json":{"schema":{"properties":{"requestId":{"type":"string","example":"example"},"refunds":{"type":"array","items":{"$ref":"#\/components\/schemas\/ItemMarketplaceRefundRequestArrayData"}},"refundsUuid":{"type":"string","example":"example"},"urlStatus":{"type":"string","example":"https:\/\/przelewy24.pl"}},"type":"object"}},"application\/x-www-form-urlencoded":{"schema":{"description":"Input parameters.","properties":{"requestId":{"type":"string","example":"example"},"refunds":{"type":"array","items":{"$ref":"#\/components\/schemas\/ItemMarketplaceRefundRequestArrayData"}},"refundsUuid":{"type":"string","example":"example"},"urlStatus":{"type":"string","example":"https:\/\/przelewy24.pl"}},"type":"object"}}}},"responses":{"200":{"description":"Request has been processed successful. Parameter 'data' contains all refunds.","content":{"application\/json":{"schema":{"properties":{"data":{"type":"array","items":{"properties":{"orderId":{"type":"integer","example":"12434"},"sessionId":{"type":"string","example":"example"},"merchantId":{"type":"integer","example":"1000123"},"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/ItemMarketplaceCartRefundArrayData"}}},"type":"object"}},"responseCode":{"type":"integer","example":"0"}},"type":"object"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"Parameter 'error' contains all refunds and information about error reason for the wrong ones.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRefund409"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/refunds\/date\/{date}":{"get":{"tags":["Refunds"],"summary":"Get refunds details for given date","parameters":[{"name":"date","in":"path","description":"refunds date in Ymd","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request has been processed successful. Parameter 'data' contains refunds details.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RefundsByDeteResponse200"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Refunds for given date not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RefundsDetailsNotFoundResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/refunds\/info\/{orderId}":{"get":{"tags":["Refunds"],"summary":"Get refunds info for given orderId","parameters":[{"name":"orderId","in":"path","description":"orderId","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Request has been processed successful. Parameter 'data' contains refunds details.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RefundsInfoResponse200"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"404":{"description":"Refunds for given orderId not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RefundsDetailsNotFoundResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/refund":{"post":{"tags":["Transaction"],"summary":"Create refund for one or more transactions.","requestBody":{"description":"Parameter 'refunds' may contain multiple refunds.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRefundJsonRequestBody"}},"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/TransactionRefundJsonRequestBody"}}}},"responses":{"200":{"description":"Request has been processed successful. Parameter 'data' contains all refunds.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRefund200"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"Parameter 'error' contains all refunds and information about error reason for the wrong ones.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRefund409"}}}}},"callbacks":{"transactionRefundNotification":{"{$request.body.urlStatus}":{"post":{"requestBody":{"description":"Request which will be sent by Przelewy24","content":{"application\/json":{"schema":{"properties":{"orderId":{"type":"integer","example":1001,"description":"ID of the refunded transaction in P24 system"},"sessionId":{"type":"string","example":"zamowienie-1","description":"ID of the refunded transaction in Partner's system"},"merchantId":{"type":"integer","example":11601,"description":"Merchant's ID of whose account the refund is performed"},"requestId":{"type":"string","example":"rq10","description":"ID of refund request provided in transaction\/refund"},"refundsUuid":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000","description":"ID of refund request in Partner's system provided in transaction\/refund"},"amount":{"type":"integer","example":123,"description":"Refund amount expressed in lowest currency unit, e.g. 1.23 PLN = 123"},"currency":{"type":"string","example":"PLN","description":"Refund currency"},"timestamp":{"type":"integer","example":1627055069,"description":"Time of sending the refund notification provided in UNIX timestamp"},"status":{"type":"integer","example":0,"description":"Status of the executed refund. The parameter always takes the value 0, which means success"},"sign":{"type":"string","example":"2f0ee3e77c92afdc0650e33334b18816f7f54d7237ac766fefb5e0e9e39cd3f824a0f7de0481417cc106f2c7e73aa402","description":"Checksum sha384 of parameters: {\"orderId\":int,\"sessionId\":\"str\",\"refundsUuid\":\"str\",\"merchantId\":int,\"amount\":int,\"currency\":\"str\",\"status\":int,\"crc\":\"str\"}"}}}}}},"responses":{"200":{"description":"Your code at urlStatus must return status 200"}}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/marketplace\/transaction\/register":{"post":{"tags":["Transaction"],"summary":"Returns unique token required for payment process","requestBody":{"description":"Input data format","required":false,"content":{"application\/json":{"schema":{"type":"object","$ref":"#\/components\/schemas\/MarketplaceTransactionRegisterV1"}}}},"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRegistrationResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/marketplace\/register\/simp":{"post":{"tags":["Transaction"],"summary":"Returns unique token with iban and company name required for payment process","requestBody":{"description":"Input data format","required":false,"content":{"application\/json":{"schema":{"type":"object","$ref":"#\/components\/schemas\/MarketplaceTransactionRegisterSimpV1"}}}},"responses":{"201":{"description":"successful operation","content":{"application\/json":{"schema":{"properties":{"token":{"type":"string","default":"1A2B3C4D5E-A1B2C3-A1B2C3-1A2B3C4D5E"},"iban":{"type":"string","default":"PL10105000997603123456789123"},"companyName":{"type":"string","default":"CompanyName"}},"type":"object"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/register\/splitpayment":{"post":{"tags":["Transaction"],"summary":"Returns unique token required for split payment process","requestBody":{"description":"Input data format","required":false,"content":{"application\/json":{"schema":{"type":"object","$ref":"#\/components\/schemas\/SplitTransactionRegister"}}}},"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRegistrationResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/register":{"post":{"tags":["Transaction"],"summary":"Returns unique token required for payment process","requestBody":{"description":"Input data format","required":false,"content":{"application\/json":{"schema":{"type":"object","$ref":"#\/components\/schemas\/TransactionRegister"}}}},"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRegistrationResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"callbacks":{"transactionRegisterNotification":{"{$request.body.urlStatus}":{"post":{"requestBody":{"description":"Request which will be sent by Przelewy24","content":{"application\/json":{"schema":{"properties":{"merchantId":{"type":"integer","example":1001,"description":"Merchant identification number"},"posId":{"type":"integer","example":2001,"description":"Shop identification number (defaults to merchant ID)"},"sessionId":{"type":"string","example":"sess007","description":"Unique identifier from merchant's system","maxLength":100},"amount":{"type":"integer","example":123,"description":"Transaction amount expressed in lowest currency unit, e.g. 1.23 PLN = 123"},"originAmount":{"type":"integer","example":123,"description":"Transaction amount expressed in lowest currency unit, e.g. 1.23 PLN = 123"},"currency":{"type":"string","example":"PLN","description":"Currency compatible with ISO, e.g. PLN","maxLength":3},"orderId":{"type":"integer","example":2201,"description":"Transaction number assigned by P24"},"methodId":{"type":"integer","example":4201,"description":"Payment method used by customer"},"statement":{"type":"string","example":"for bicycle","description":"Payment title"},"sign":{"type":"string","example":"2f0ee3e77c92afdc0650e33334b18816f7f54d7237ac766fefb5e0e9e39cd3f824a0f7de0481417cc106f2c7e73aa402","description":"Checksum sha384 of parameters: ({\"merchantId\":int,\"posId\":int,\"sessionId\":\"string\",\"amount\":int,\"originAmount\":int,\"currency\":\"string\",\"orderId\":int,\"methodId\":int,\"statement\":\"string\",\"crc\":\"string\"})"}}}}}},"responses":{"200":{"description":"Your code at urlStatus must return status 200"}}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/register\/simp":{"post":{"tags":["Transaction"],"summary":"Returns unique token with iban and company name required for payment process","requestBody":{"description":"Input data format","required":false,"content":{"application\/json":{"schema":{"type":"object","$ref":"#\/components\/schemas\/TransactionRegisterSimpV1"}}}},"responses":{"201":{"description":"successful operation","content":{"application\/json":{"schema":{"properties":{"token":{"type":"string","default":"1A2B3C4D5E-A1B2C3-A1B2C3-1A2B3C4D5E"},"iban":{"type":"string","default":"PL10105000997603123456789123"},"companyName":{"type":"string","default":"CompanyName"}},"type":"object"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/register\/ttl":{"post":{"tags":["Transaction"],"summary":"Returns unique token required for payment process","requestBody":{"description":"Input data format","required":false,"content":{"application\/json":{"schema":{"type":"object","$ref":"#\/components\/schemas\/TransactionRegisterTTL"}}}},"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRegistrationResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/registerOffline":{"post":{"tags":["Transaction"],"summary":"Register offline transaction.","requestBody":{"description":"Input parameters.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRegisterOfflineRequest"}},"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/TransactionRegisterOfflineRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRegistrationOffline200"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRegistrationOffline409"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/reject":{"put":{"tags":["Transaction"],"summary":"Reject transaction.","requestBody":{"description":"Input parameters. Sign is SHA-384 hash calculated using JSON encoded array, that contains keys: 'merchantId', 'orderId', 'sessionId' and 'crc'.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionRejectJsonRequestBodyV11"}},"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/TransactionRejectJsonRequestBodyV11"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionReject200"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"500":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/marketplace\/transaction\/release":{"post":{"tags":["Transaction"],"summary":"Method releasing child transaction to payout","requestBody":{"description":"Input parameters.","content":{"application\/json":{"schema":{"description":"Input parameters.","properties":{"requestId":{"type":"string"},"details":{"properties":{"orderId":{"type":"integer"},"sessionId":{"type":"string"},"merchantId":{"type":"integer"},"items":{"type":"array","items":{"properties":{"sessionId":{"type":"string"},"amount":{"type":"integer"},"tergetPosId":{"type":"integer"}},"type":"object"}}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Request successful.","content":{"application\/json":{"schema":{"description":"Response","properties":{"data":{"properties":{"orderId":{"type":"integer"},"sessionId":{"type":"string"},"merchantId":{"type":"integer"},"items":{"type":"array","items":{"properties":{"sessionId":{"type":"string"},"amount":{"type":"integer"},"tergetPosId":{"type":"integer"},"released":{"type":"boolean"},"message":{"type":"string"}},"type":"object"}}},"type":"object"}},"type":"object"}}}},"422":{"description":"Some error occured.","content":{"application\/json":{"schema":{"description":"Response","properties":{"data":{"properties":{"orderId":{"type":"integer"},"sessionId":{"type":"string"},"merchantId":{"type":"integer"},"items":{"type":"array","items":{"properties":{"sessionId":{"type":"string"},"amount":{"type":"integer"},"tergetPosId":{"type":"integer"},"released":{"type":"boolean"},"message":{"type":"string"}},"type":"object"}}},"type":"object"}},"type":"object"}}}},"401":{"description":"Not authorized.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"400":{"description":"Transaction not found","content":{"application\/json":{"schema":{"description":"Response","properties":{"error":{"type":"string","default":"Not found item"},"code":{"type":"integer","default":"400"}},"type":"object"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/transaction\/verify":{"put":{"tags":["Transaction"],"summary":"Verifies result of transaction","requestBody":{"description":"Input data format","content":{"application\/x-www-form-urlencoded":{"schema":{"required":["posId","sessionId","amount","currency","orderId","sign"],"properties":{"posId":{"description":"Shop identification number (defaults to merchant ID)","type":"integer"},"sessionId":{"description":"Unique identifier from merchant's system","type":"string","maxLength":100},"amount":{"description":"Transaction amount which format is presented as amount in given currency divided by 100 (AMOUNT\/100)","type":"integer"},"currency":{"description":"Currency","type":"string","maxLength":3},"orderId":{"description":"Id of order","type":"integer"},"sign":{"description":"Control sum *","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransactionVerificationResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/marketplace\/transfer\/balance\/move":{"post":{"tags":["Transfer"],"summary":"Transfer funds from owner Express account to acceptant account in p24","requestBody":{"description":"Input parameters","content":{"application\/json":{"schema":{"description":"Input parameters.","required":["requestId","targetPosId","sessionId","title","amount","currency","sign","referenceNumber"],"properties":{"requestId":{"type":"string"},"targetPosId":{"type":"integer"},"sessionId":{"type":"string"},"title":{"type":"string"},"amount":{"type":"integer"},"currency":{"description":"currency in ISO 4217 format.","type":"string"},"referenceNumber":{"type":"integer"},"sign":{"description":"control sum.","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MoveBalance201"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MoveBalance409"}}}},"422":{"description":"Unprocessable Content","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MoveBalance422"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/marketplace\/transfer\/recharge":{"post":{"tags":["Transfer"],"summary":"Recharge transfer funds","requestBody":{"description":"Input parameters","content":{"application\/json":{"schema":{"description":"Input parameters.","required":["posId","targetPosId","sessionId","amount","description","sign"],"properties":{"posId":{"type":"integer"},"targetPosId":{"type":"string"},"sessionId":{"type":"string"},"amount":{"type":"integer"},"description":{"description":"description","type":"string"},"requestId":{"description":"unique request id to prevent multiple processes","type":"string"},"sign":{"description":"control sum","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransferRecharge201"}}}},"200":{"description":"OK - request already processed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransferRecharge201"}}}},"409":{"description":"Conflict","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransferRecharge409"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TransferRecharge404"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/user":{"post":{"tags":["User"],"summary":"Create new user.","requestBody":{"description":"New user data.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserCreateJsonRequestBody"}}}},"responses":{"200":{"description":"Request has been processed successful. User already exists. Parameter 'data' contains id of user in P24 system.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserCreateResponse200"}}}},"400":{"description":"Invalid input data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvalidInputData"}}}},"401":{"description":"Not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}},"409":{"description":"User exists","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UserCreateResponse409"}}}},"503":{"description":"Undefined error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}}},"security":[{"basicAuth":[]}]}},"\/v1\/user\/methods\/{userId}":{"get":{"tags":["User"],"summary":"Get available payment methods for user.","parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GeneratePaymentMethodsResponse"}}}},"400":{"description":"bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorCodeResponse"}}}},"403":{"description":"not authorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UnauthorizedResponse"}}}}},"security":[{"basicAuth":[]}]}}},"components":{"schemas":{"CardChargeRequestBody":{"properties":{"token":{"type":"string","example":"1111111111-222222-333333-abcdefghij"}},"type":"object"},"ChargeCardSuccessResponse":{"properties":{"data":{"properties":{"orderId":{"type":"integer","example":123456789}},"type":"object"},"responseCode":{"type":"string","example":"0"}},"type":"object"},"CheckCardSuccessResponse":{"properties":{"responseCode":{"type":"string","example":"0"}},"type":"object"},"GetCardInfoResponseData":{"properties":{"data":{"properties":{"refId":{"type":"string","default":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX"},"bin":{"type":"integer","default":"000000"},"mask":{"type":"string","default":"xxxxxxxxxxxx0000"},"cardType":{"type":"string","default":"visa"},"cardDate":{"type":"string","default":"012020"},"hash":{"type":"string","default":"247fc1c866a7ce3a92f4a187d124350b2051e93c918b8a87facec230cf87f6e1"},"tokenStatus":{"type":"string","default":"active"},"cardLogotype":{"properties":{"width":{"type":"string","default":"100"},"length":{"type":"string","default":"100"},"url":{"type":"string","default":"https:\/\/wwww.example.com"}},"type":"object"},"cardArt":{"properties":{"width":{"type":"string","default":"100"},"length":{"type":"string","default":"100"},"url":{"type":"string","default":"https:\/\/wwww.example.com"}},"type":"object"},"tokenExpire":{"properties":{"year":{"type":"string","default":"2055"},"month":{"type":"string","default":"10"}},"type":"object"},"additional":{"description":"Additional params are available only with permission","properties":{"logotypeGuid":{"type":"string","default":"4428da93468a8435f056e4984997"},"artGuid":{"type":"string","default":"default_card_art"},"networkTokenId":{"type":"string","default":"b4f926fee94a85d75e071180ac4372"},"networkToken":{"type":"string","default":"4895379992344190"}},"type":"object"}},"type":"object"},"responseCode":{"type":"integer","example":"0"}},"type":"object"},"cardPayNotificationPositiveAuthorization":{"properties":{"amount":{"description":"Transaction amount","type":"integer","example":"10"},"3ds":{"description":"Was 3D-Secure performed during payment?","type":"boolean","example":true},"method":{"description":"Payment method ID","type":"integer","example":218},"refId":{"description":"Card reference number","type":"string","example":"10636C17-982F797F-E256FF6A-AED9D667"},"orderId":{"description":"Transaction number assigned by P24 for oneclick sampling","type":"integer","example":300188118},"sessionId":{"description":"Unique identifier from merchant's system","type":"string","example":"session_1567679496185"},"bin":{"description":"Registered card bin","type":"integer","example":901000},"maskedCCNumber":{"description":"Masked card number, format: XXXXXXXXXXXX1234","type":"string","example":"xxxxxxxxxxxx0001"},"ccExp":{"description":"Card expiry date in MMYYYY format eg. 122020","type":"string","example":"012022"},"hash":{"description":"Unique card hash \u2013 unique for each card","type":"string","example":"2c73d10720b6bb9bfe9458da1b4c09ac71baaea519ba0f24049ba6f787ab270ce88eb2194642422be20b7f7fbd2a702c"},"cardCountry":{"description":"Country code compatible with ISO, e.g. PL","type":"string","example":"PL"},"cardType":{"description":"Card type (VISA, ECMC)","type":"string","example":"visa"},"risk":{"description":"0 \u2013 safe, 1 \u2013 suspicious, 2 \u2013 hazardous. Score calculated using a card payment risk calculation tool","type":"integer","enum":[0,1,2]},"liabilityshift":{"description":"1 \u2013 Yes, 0 \u2013 No","type":"boolean","example":false},"sign":{"description":"SHA384","type":"string","example":"692b843724c5103d720f26dd1a09148ff9672f104c26aecf95a6d86e01bf9b01a1909f3689093f91640c157bc9fe0cf9"}},"type":"object"},"cardPayNotificationNegativeAuthorization":{"properties":{"amount":{"description":"Transaction amount","type":"integer","example":"10"},"3ds":{"description":"Was 3D-Secure performed during payment?","type":"boolean","example":true},"method":{"description":"Payment method ID","type":"integer","example":218},"refId":{"description":"Card reference number","type":"string","example":"10636C17-982F797F-E256FF6A-AED9D667"},"orderId":{"description":"Transaction number assigned by P24 for oneclick sampling","type":"integer","example":300188118},"sessionId":{"description":"Unique identifier from merchant's system","type":"string","example":"session_1567679496185"},"errorCode":{"description":"Error code","type":"string","example":"err170"},"errorMessage":{"description":"Error description","type":"string","example":"Sth error"},"sign":{"description":"SHA384","type":"string","example":"692b843724c5103d720f26dd1a09148ff9672f104c26aecf95a6d86e01bf9b01a1909f3689093f91640c157bc9fe0cf9"}},"type":"object"},"CardInsertSuccessResponse":{"properties":{"data":{"type":"array","items":{"properties":{"orderId":{"type":"integer","example":123456789}},"type":"object"}},"responseCode":{"type":"string","example":"0"}},"type":"object"},"CardInsertResponse409":{"properties":{"error":{"type":"string","example":"Transaction token has been used."},"code":{"type":"number","example":1}},"type":"object"},"CardInsertRequestBody":{"properties":{"transactionToken":{"type":"string","example":"1111111111-222222-333333-4444444444"},"cardNumber":{"type":"string","example":"1234123412341234"},"cardDate":{"type":"string","example":"122025"},"cvv":{"type":"string","example":"123"},"clientName":{"type":"string","example":"Jan Kowalski"},"check":{"type":"integer","example":1}},"type":"object"},"CardPaySuccessResponse":{"properties":{"data":{"type":"array","items":{"properties":{"orderId":{"type":"integer","example":123456789}},"type":"object"}},"responseCode":{"type":"string","example":"0"}},"type":"object"},"CardPayThreeDSecureResponse":{"properties":{"data":{"type":"array","items":{"properties":{"orderId":{"type":"integer","example":123456789},"redirectUrl":{"type":"string","example":"https:\/\/secure.przelewy24.pl\/3ds\/abc123"}},"type":"object"}},"responseCode":{"type":"string","example":"0"}},"type":"object"},"CardPayResponse409":{"properties":{"error":{"type":"string","example":"Unable to make payment."},"code":{"type":"number","example":8}},"type":"object"},"CardRegisterSuccessResponse":{"properties":{"data":{"type":"array","items":{"properties":{"oneclickOrderId":{"type":"integer","example":123456789},"recurringOrderId":{"type":"integer","example":123456789}},"type":"object"}},"responseCode":{"type":"string","example":"0"}},"type":"object"},"CardRegisterRequestBody":{"properties":{"transactionToken":{"type":"string","example":"1111111111-222222-333333-4444444444"},"cardNumber":{"type":"string","example":"1234123412341234"},"cardDate":{"type":"string","example":"122025"},"cvv":{"type":"string","example":"123"},"clientName":{"type":"string","example":"Jan Kowalski"}},"type":"object"},"CreateOfferRequestV1":{"required":["description","startDate","commissions","formGroups","fees","feesConfig"],"properties":{"description":{"type":"string","maximum":255,"minimum":1,"example":"do-3-razy-sztuka"},"note":{"type":"string","maximum":1000,"minimum":1,"example":"Notatka dla oferty"},"vatId":{"type":"string","example":"PL1571681301"},"startDate":{"type":"string","example":"2024-07-29 00:00:00"},"endDate":{"type":"string","example":"2024-09-29 00:00:00"},"maxUseNumber":{"type":"integer","example":"5"},"state":{"type":"integer","example":"0"},"commissions":{"properties":{"formGroups":{"description":"formGroupTypes: SharedLibraries\\ValueObject\\CommissionOffer\\FormGroupType","properties":{"blik":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsBlikRequestV1"},"etransfer":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsEtransferRequestV1"},"wallet":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsWalletRequestV1"}},"type":"object"},"fees":{"description":"fee: SharedLibraries\\ValueObject\\CommissionOffer\\FeeType","properties":{"fee0":{"$ref":"#\/components\/schemas\/FeesSingleRequestV1"},"fee1":{"$ref":"#\/components\/schemas\/FeesSingleRequestV1"}},"type":"object"},"feesConfig":{"description":"feeConfig: SharedLibraries\\ValueObject\\CommissionOffer\\FeeConfigType","properties":{"feeConfig0":{"type":"string","example":"1"},"feeConfig1":{"type":"string","example":"merchnat"}},"type":"object"}},"type":"object"}},"type":"object"},"FormGroupsConfigurationsBlikRequestV1":{"description":"FormGroupsConfigurationTypes: SharedLibraries\\ValueObject\\CommissionOffer\\FormGroupConfigurationType","required":["defaultConfiguration"],"properties":{"defaultConfiguration":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSingleRequestV1"},"subgroups":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSubgroupSingleBlikRequestV1"}},"type":"object"},"FormGroupsConfigurationsEtransferRequestV1":{"description":"FormGroupsConfigurationTypes: SharedLibraries\\ValueObject\\CommissionOffer\\FormGroupConfigurationType","required":["defaultConfiguration"],"properties":{"defaultConfiguration":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSingleRequestV1"},"subgroups":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSubgroupSingleEtransferRequestV1"}},"type":"object"},"FormGroupsConfigurationsWalletRequestV1":{"description":"FormGroupsConfigurationTypes: SharedLibraries\\ValueObject\\CommissionOffer\\FormGroupConfigurationType","required":["defaultConfiguration"],"properties":{"defaultConfiguration":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSingleRequestV1"},"subgroups":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSubgroupSingleWalletRequestV1"}},"type":"object"},"FormGroupsConfigurationsSubgroupSingleBlikRequestV1":{"description":"subgroupTypes: SharedLibraries\\ValueObject\\PaymentMethod\\Type","properties":{"17":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSingleRequestV1"}},"type":"object"},"FormGroupsConfigurationsSubgroupSingleEtransferRequestV1":{"description":"subgroupTypes: SharedLibraries\\ValueObject\\PaymentMethod\\Type","properties":{"1":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSingleRequestV1"},"2":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSingleRequestV1"},"8":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSingleRequestV1"}},"type":"object"},"FormGroupsConfigurationsSubgroupSingleWalletRequestV1":{"description":"subgroupTypes: SharedLibraries\\ValueObject\\PaymentMethod\\Type","properties":{"13":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSingleRequestV1"},"14":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsSingleRequestV1"}},"type":"object"},"FormGroupsConfigurationsSingleRequestV1":{"required":["label","surcharge","commission","commissionMax","commissionMin"],"properties":{"label":{"type":"string","example":"my configuration label"},"surcharge":{"type":"integer","example":"0"},"commission":{"type":"integer","example":"0"},"commissionMax":{"type":"integer","example":"0"},"commissionMin":{"type":"integer","example":"0"}},"type":"object"},"FeesSingleRequestV1":{"required":["label","fee"],"properties":{"label":{"type":"string","example":"myFeeLabel"},"fee":{"type":"integer","example":"150"}},"type":"object"},"PatchOfferRequestV1":{"required":["creatorId","creatorType","commissions","formGroups","fees","feesConfig"],"properties":{"description":{"type":"string","maximum":255,"minimum":1,"example":"do-3-razy-sztuka"},"note":{"type":"string","maximum":1000,"minimum":1,"example":"do-4-razy-sztuka"},"vatId":{"type":"string","example":"PL1571681301"},"creatorId":{"type":"integer","example":"3332"},"creatorType":{"type":"integer","example":"1"},"startDate":{"type":"string","example":"2024-07-29 00:00:00"},"endDate":{"type":"string","example":"2024-09-29 00:00:00"},"state":{"type":"integer","example":"0"},"maxUseNumber":{"type":"integer","example":"15"},"commissions":{"properties":{"formGroups":{"description":"formGroupTypes: SharedLibraries\\ValueObject\\CommissionOffer\\FormGroupType","properties":{"blik":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsBlikRequestV1"},"etransfer":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsEtransferRequestV1"},"wallet":{"$ref":"#\/components\/schemas\/FormGroupsConfigurationsWalletRequestV1"}},"type":"object"},"fees":{"description":"fee: SharedLibraries\\ValueObject\\CommissionOffer\\FeeType","properties":{"fee0":{"$ref":"#\/components\/schemas\/FeesSingleRequestV1"},"fee1":{"$ref":"#\/components\/schemas\/FeesSingleRequestV1"}},"type":"object"},"feesConfig":{"description":"feeConfig: SharedLibraries\\ValueObject\\CommissionOffer\\FeeConfigType","properties":{"feeConfig0":{"type":"string","example":"1"},"feeConfig1":{"type":"string","example":"merchnat"}},"type":"object"}},"type":"object"}},"type":"object"},"UnauthorizedResponse":{"properties":{"error":{"type":"string","example":"Incorrect authentication"},"code":{"type":"number","example":401}},"type":"object"},"ForbiddenResponse":{"properties":{"error":{"type":"string","example":"string"},"code":{"type":"integer","default":403}},"type":"object"},"TransactionBySessionIdSuccessResponse":{"properties":{"data":{"$ref":"#\/components\/schemas\/TransactionBySessionIdResponse"},"responseCode":{"type":"string","default":"0"}},"type":"object"},"TransactionFundsSuccessResponse":{"properties":{"amount":{"description":"Remaining amount available for refund","type":"integer","example":10000}},"type":"object"},"GetAffiliateApiKeyResponse":{"properties":{"api_key":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}},"type":"object"},"ApiKeyErrorResponse":{"properties":{"error":{"type":"string"},"status":{"type":"number"}},"type":"object"},"BasicResponse":{"properties":{"data":{"type":"array","items":{"type":"string"}},"responseCode":{"type":"string"}},"type":"object"},"MultiStoreUpdateIpAddressesParameters":{"required":["ipAddress"],"properties":{"ipAddress":{"description":"ip addresses","type":"array","items":{"type":"string","example":"192.168.0.1"}}},"type":"object"},"TransactionBySessionIdResponse":{"allOf":[{"$ref":"#\/components\/schemas\/TransactionAbstractResponse"},{"properties":{"statement":{"type":"string"}},"type":"object"}]},"TransactionAbstractResponse":{"properties":{"orderId":{"type":"integer"},"sessionId":{"type":"integer"},"status":{"type":"integer"},"amount":{"type":"integer"},"currency":{"type":"string","default":"PLN"},"date":{"type":"string","default":"201701010000"},"dateOfTransaction":{"type":"string","default":"201701010000"},"clientEmail":{"type":"string","default":"example@przelewy24.pl"},"accountMD5":{"type":"integer"},"paymentMethod":{"type":"integer"},"description":{"type":"integer"},"clientName":{"type":"integer"},"clientAddress":{"type":"integer"},"clientCity":{"type":"integer"},"clientPostcode":{"type":"integer"},"batchId":{"type":"integer"},"fee":{"type":"string","default":"0"}},"type":"object"},"MerchantExistResponse":{"properties":{"error":{"type":"string"},"data":{"type":"array","items":{"type":"string"}}},"type":"object"},"GetAffiliateCrcResponse":{"required":["error"],"properties":{"error":{"type":"string"},"data":{"type":"array","items":{"type":"string"}}},"type":"object"},"GetExchangeRateResponse":{"properties":{"data":{"properties":{"exchange":{"type":"string","example":"1000"},"amount":{"type":"string","example":"43.40"},"rate":{"type":"string","example":"4.3400"}},"type":"object"},"responseCode":{"type":"integer","default":"0"}},"type":"object"},"GetMerchantFundsResponse":{"required":["funds","status"],"properties":{"error":{"type":"string"},"funds":{"type":"number"},"status":{"type":"integer"}},"type":"object"},"GetMultiStoreIpAddressesResponse":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"integer","example":12345},"ipAddress":{"type":"array","items":{"type":"string","example":"192.168.0.0.1"}}},"type":"object"}}},"type":"object"},"MerchantRegistrationResponse":{"properties":{"code":{"type":"integer"},"data":{"type":"array","items":{"type":"string"}}},"type":"object"},"MerchantConfigurationV10Response":{"properties":{"data":{"type":"array","items":{"properties":{"waitForResult":{"type":"integer"},"signUndefined":{"type":"integer"}},"type":"object"}},"code":{"type":"string","example":"200"}},"type":"object"},"MerchantConfigurationV10NotFoundResponse":{"properties":{"error":{"type":"string","example":"Not found"},"code":{"type":"integer","example":"404"}},"type":"object"},"GetAffiliatesSuccessResponse":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"integer","example":10000},"name":{"type":"string","example":"Nazwa firmy"},"nip":{"type":"string","example":"1255548394"},"regon":{"type":"string","example":"359653280"},"customerStatus":{"type":"string","example":"Verified"}},"type":"object"}},"code":{"type":"integer","example":200}},"type":"object"},"GetAffiliatesNotFoundResponse":{"properties":{"error":{"type":"string","example":"Affiliates not found"},"code":{"type":"integer","example":404}},"type":"object"},"GetAffiliatesUnprocessableEntityResponse":{"properties":{"error":{"type":"string","example":"Unprocessable Entity"},"code":{"type":"integer","example":422}},"type":"object"},"TransactionDispatchItemsResponse":{"properties":{"data":{"properties":{"parentTransaction":{"$ref":"#\/components\/schemas\/ItemByOrderIdData"},"splittedTransaction":{"type":"array","items":{"$ref":"#\/components\/schemas\/ItemByOrderIdDataSplitted"}}},"type":"object"},"responseCode":{"type":"integer","default":"0"}},"type":"object"},"ItemByOrderIdData":{"properties":{"orderId":{"type":"integer","example":100100},"sessionId":{"type":"string","example":"zamowienie-1"},"amount":{"type":"integer","example":100},"currency":{"type":"string","example":"PLN"},"status":{"type":"string","example":"Completed"},"merchantId":{"type":"integer","example":1001}},"type":"object"},"ItemByOrderIdDataSplitted":{"properties":{"orderId":{"type":"integer","example":100101},"sessionId":{"type":"string","example":"unique sessionId"},"amount":{"type":"integer","example":100},"merchantId":{"type":"integer","example":1001},"status":{"type":"string","example":"Completed"},"itemId":{"type":"string","example":"unique itemId"},"fee":{"type":"integer","example":1}},"type":"object"},"DispatchSucceedResponse":{"properties":{"result":{"type":"array","items":{"properties":{"orderId":{"type":"integer","example":123456},"orderIdNew":{"type":"integer","example":123457},"sessionId":{"type":"string","example":"zamowienie-1"},"sellerId":{"type":"integer","example":99999},"amount":{"type":"integer","example":100},"status":{"type":"boolean","example":true},"error":{"type":"integer","example":""}},"type":"object"}},"error":{"type":"array","items":{"properties":{"errorCode":{"type":"integer","example":0},"errorMessage":{"type":"string","example":"Success, no error."}},"type":"object"}}},"type":"object"},"DispatchErrorResponse":{"properties":{"result":{"type":"array","items":{"properties":{"orderId":{"type":"integer","example":123456},"orderIdNew":{"type":"integer","example":0},"sessionId":{"type":"string","example":"zamowienie-1"},"sellerId":{"type":"integer","example":99999},"amount":{"type":"integer","example":100},"status":{"type":"boolean","example":false},"error":{"type":"integer","example":"Error message"}},"type":"object"}},"error":{"type":"array","items":{"properties":{"errorCode":{"type":"integer","example":600},"errorMessage":{"type":"string","example":"Example error"}},"type":"object"}}},"type":"object"},"DispatchDetailsParameters":{"required":["batchId"],"properties":{"batchId":{"description":"Dispatch batch identification value","type":"integer"},"orderId":{"type":"integer","example":123456},"sessionId":{"type":"string","example":"zamowienie-1"},"sellerId":{"type":"integer","example":99999},"amount":{"type":"integer","example":100},"items":{"properties":{"itemId":{"type":"string","example":"item-123456"},"quantity":{"type":"integer","example":1},"price":{"type":"integer","example":100},"description":{"type":"string","example":"opis produktu"}},"type":"object"}},"type":"object"},"RecurringParameters":{"properties":{"type":{"type":"string"},"expirationDate":{"type":"string"},"initDate":{"type":"string"},"frequency":{"type":"string"},"totalLimitAmount":{"type":"integer"},"limitAmount":{"type":"integer"},"totalLimitCount":{"type":"integer"},"availableBanks":{"type":"boolean"}},"type":"object"},"ChargeByCodeParameters":{"required":["token","blikCode"],"properties":{"token":{"description":"unique reference to transaction","type":"string"},"blikCode":{"description":"6-digit, one-time BLIK code generated in the app","type":"string"},"aliasValue":{"description":"Unique alias of the user which can be used to charge next client transactions","type":"string","maxLength":64,"minLength":5},"aliasLabel":{"description":"Alias label displayed in the app","type":"string","maxLength":20,"minLength":5},"recurring":{"description":"Data defining a recurring payment type - the type of recurring payment; allowed values: A, M, O\n     *    expirationDate - allowed format: YYYY-MM-DD hh:mm:ss\n     *    initDate - allowed format: YYYY-MM-DD\n     *    frequency - frequency of the recurrency; value must fulfill regex: [1-9][0-9]{0,2}[DWMY])\n     *    totalLimitAmount - maximum total amount that will be charged through the process; allowed type: integer\n     *    limitAmount - maximum amount that will be charged in a single payment; allowed type: integer\n     *    totalLimitCount - number of payments that will be issued in the whole process; allowed type: integer\n     *    availableBanks - parameter to control the verification of whether the bank supports recursion.\n     *    If set to false, it is not checked if the bank supports recursion.; default: true; allowed type: boolean\n     *    Fields expirationDate, initDate, frequency, totalLimitAmount, limitAmount are required when type is set to A,\n     *    totalLimitCount is required with all type settings","type":"array","items":{"$ref":"#\/components\/schemas\/RecurringParameters"}}},"type":"object"},"ChargeByAliasParameters":{"required":["token","type"],"properties":{"token":{"description":"unique reference to transaction","type":"string"},"type":{"description":"Method execute option","type":"string","enum":["alias","alternativeKey","blikCode"]},"alternativeKey":{"description":"key assigned to mobile app","type":"string","enum":["alias","alternativeKey","blikCode"]},"blikCode":{"description":"6-digit, one-time BLIK code generated in the app","type":"string"},"recurring":{"description":"Data defining a recurring payment\n     *    <b>type<\/b> - the type of recurring payment; allowed values: A, M, O\n     *    <b>expirationDate<\/b> - allowed format: YYYY-MM-DD hh:mm:ss\n     *    <b>initDate<\/b> - allowed format: YYYY-MM-DD\n     *    <b>frequency<\/b> - frequency of the recurrency; value must fulfill regex: [1-9][0-9]{0,2}[DWMY]\n     *    <b>totalLimitAmount<\/b> - maximum total amount that will be charged through the process; allowed type: integer\n     *    <b>limitAmount<\/b> - maximum amount that will be charged in a single payment; allowed type: integer\n     *    <b>totalLimitCount<\/b> - number of payments that will be issued in the whole process; allowed type: integer\n     *    <b>availableBanks<\/b> - parameter to control the verification of whether the bank supports recursion. If set\n     *    to false, it is not checked if the bank supports recursion.; default: true; allowed type: boolean\n     *\n     *    Fields <b>expirationDate<\/b>, <b>initDate<\/b>, <b>frequency<\/b>, <b>totalLimitAmount<\/b>, <b>limitAmount<\/b> are required\n     *    when\n     *    <b>type<\/b> is set to A,\n     *    <b>totalLimitCount<\/b> is required with all type settings","type":"array","items":{"$ref":"#\/components\/schemas\/RecurringParameters"}},"oneclickAuto":{"description":"Data defining an oneclick payment","type":"boolean"}},"type":"object"},"GetAliasesByEmailResponse":{"properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/GetAliasesByEmailSingle"}},"responseCode":{"type":"integer","example":"0"}},"type":"object"},"GetAliasesByEmailSingle":{"properties":{"value":{"type":"string","example":"JohnDoeAlias"},"type":{"type":"string","example":"UID"},"status":{"type":"string","example":"REGISTERED"}},"type":"object"},"BlikChargeByAliasResponse":{"properties":{"data":{"properties":{"orderId":{"type":"integer"},"message":{"type":"string"}},"type":"object"}},"type":"object"},"ChargeByAlias409":{"properties":{"error":{"type":"array","items":{"$ref":"#\/components\/schemas\/ChargeByAlias409Item"}},"code":{"type":"integer","example":51}},"type":"object"},"ChargeByAlias409Item":{"properties":{"message":{"type":"string","example":"example"},"alternativeKeys":{"type":"array","items":{"$ref":"#\/components\/schemas\/alternativeKeysItem"}}},"type":"object"},"alternativeKeysItem":{"properties":{"label":{"type":"string","example":"label01"},"alias":{"type":"string","example":"alias01"}},"type":"object"},"BlikChargeByCodeResponse":{"properties":{"data":{"properties":{"orderId":{"type":"integer"},"message":{"type":"string"}},"type":"object"},"responseCode":{"type":"integer","default":"0"}},"type":"object"},"ReportResponseTransactionItem":{"properties":{"type":{"description":"Always transaction","type":"string","example":"transaction"},"amount":{"type":"integer","example":1234567},"currency":{"type":"string","example":"PLN"},"details":{"description":"Detailed information about transaction","type":"object"}},"type":"object"},"ReportResponseBatchItem":{"properties":{"type":{"description":"Always batch","type":"string","example":"batch"},"amount":{"type":"integer","example":54321},"currency":{"type":"string","example":"PLN"},"details":{"description":"Detailed information about batch","type":"object"}},"type":"object"},"ReportResponseRefundItem":{"properties":{"type":{"description":"Always refund","type":"string","example":"refund"},"amount":{"type":"integer","example":332211},"currency":{"type":"string","example":"PLN"},"details":{"description":"Detailed information about refund","type":"object"}},"type":"object"},"PageInformationObject":{"properties":{"recordsOnPage":{"type":"integer","example":5000},"recordsAll":{"type":"integer","example":12444},"pageCount":{"type":"integer","example":3}},"type":"object"},"ReportBatchDetailsResponse":{"properties":{"data":{"properties":{"overall":{"description":"Requested batch information","type":"object","$ref":"#\/components\/schemas\/ReportResponseBatchItem"},"transactions":{"description":"Transactions paid in requested batch","type":"array","items":{"$ref":"#\/components\/schemas\/ReportResponseTransactionItem"}},"refunds":{"description":"Refunds paid in requested batch","type":"array","items":{"$ref":"#\/components\/schemas\/ReportResponseRefundItem"}}},"type":"object"},"token":{"description":"Token, which should be used to retrieve next pages of data. Token is valid for next few minutes.","type":"string"},"responseCode":{"type":"integer"},"pageInformation":{"type":"object","$ref":"#\/components\/schemas\/PageInformationObject"}},"type":"object"},"BatchMrxItem":{"properties":{"batchId":{"description":"Batch ID","type":"integer"},"date":{"description":"Date in format YYYYMMDDHHmm","type":"string"},"amount":{"description":"Amount","type":"integer"},"commission":{"description":"Commission amount","type":"integer"},"refunds":{"description":"Refunds amount","type":"integer"},"referenceNumber":{"description":"Reference number","type":"string"}},"type":"object"},"BatchMrxTransactionItem":{"properties":{"orderId":{"description":"Short order ID","type":"integer"},"orderIdFull":{"description":"Full order ID","type":"string"},"sessionId":{"description":"Session ID","type":"string"},"status":{"description":"Transaction status","type":"integer"},"amount":{"description":"Amount","type":"integer"},"date":{"description":"Settlement date in format YYYYMMDDHHmm","type":"string"},"dateOfTransaction":{"description":"Transaction date in format YYYYMMDDHHmm","type":"string"},"clientEmail":{"description":"Client email","type":"string"},"accountNumber":{"description":"Account number MD5 hash","type":"string"},"paymentMethod":{"description":"Payment method ID","type":"integer"},"description":{"description":"Transaction description","type":"string"},"commission":{"description":"Commission","type":"integer"},"settledAmount":{"description":"Settled amount","type":"integer"}},"type":"object"},"BatchMrxRefundItem":{"properties":{"orderId":{"description":"Short order ID","type":"integer"},"orderIdFull":{"description":"Full order ID","type":"string"},"sessionId":{"description":"Session ID","type":"string"},"date":{"description":"Refund date in format YYYYMMDDHHmm","type":"string"},"status":{"description":"Refund status","type":"integer"},"amount":{"description":"Refund amount","type":"integer"},"commission":{"description":"Commission","type":"integer"}},"type":"object"},"ReportHistoryResponse":{"properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/ReportResponseTransactionItem"}},"token":{"description":"Token, which should be used to retrieve next pages of data. Token is valid for next few minutes.","type":"string"},"responseCode":{"type":"integer"},"pageInformation":{"type":"object","$ref":"#\/components\/schemas\/PageInformationObject"}},"type":"object"},"GetTransactionStatusResponseConflict":{"properties":{"status":{"type":"string","example":null,"nullable":true},"error":{"type":"string","example":"General error"}},"type":"object"},"GetTransactionStatusResponseNotFound":{"properties":{"status":{"type":"string","example":null,"nullable":true},"error":{"type":"string","example":"Transaction does not exist"}},"type":"object"},"GetTransactionStatusResponseSuccess":{"properties":{"status":{"type":"string","enum":["Incomplete","Untapped","Completed","Returned","Used","Write-off","Waiting","Rejected","To confirm"],"example":"Completed"},"error":{"type":"string","example":null,"nullable":true}},"type":"object"},"TransactionNotFoundResponse":{"properties":{"error":{"type":"string","example":"Transaction not found"},"code":{"type":"number","example":404}},"type":"object"},"InfoResponse":{"properties":{"country":{"type":"string","default":"PL"},"bank":{"type":"string","default":"PL"}},"type":"object"},"GetPayerInfoExtendedSuccessResponse":{"properties":{"data":{"properties":{"name":{"type":"string","example":"JAN NOWAK"},"street":{"type":"string","example":"UL.T\u0118CZOWA 15"},"city":{"type":"string","example":"POZNA\u0143"},"postCode":{"type":"string","example":"60-275"},"iban":{"type":"string","example":"49658765504459786094965876"},"originalString":{"type":"string","example":"JAN NOWAK UL.T\u0118CZOWA 15 60-275 POZNA\u0143"}},"type":"object"},"responseCode":{"type":"string","example":"0"}},"type":"object"},"GetPayerInfoExtendedConflictResponse":{"properties":{"error":{"type":"string","example":"Unable to continue notification process"},"code":{"type":"number","example":409}},"type":"object"},"GetPayerInfoExtendedAcceptedResponse":{"properties":{"data":{"type":"object"},"responseCode":{"type":"string","example":"0"}},"type":"object"},"GetPayerInfoExtendedNotFoundResponse":{"properties":{"error":{"type":"string","example":"Payer data not found"},"code":{"type":"number","example":404}},"type":"object"},"GetPayerInfoExtendedInvalidDataResponse":{"properties":{"error":{"type":"string","example":"Invalid input data"},"code":{"type":"number","example":400}},"type":"object"},"TransactionRefundsInfoResponse":{"properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/TransactionWithRefundsResponse"}},"responseCode":{"type":"string","example":"0"}},"type":"object"},"TransactionWithRefundsResponse":{"properties":{"orderId":{"type":"integer","example":"1001"},"sessionId":{"type":"string","example":"zamowienie-1"},"amount":{"type":"integer","example":"100"},"currency":{"type":"string","example":"PLN"},"refunds":{"type":"array","items":{"$ref":"#\/components\/schemas\/RefundsCollection"}}},"type":"object"},"RefundsCollection":{"properties":{"batchId":{"type":"integer","example":2},"requestId":{"type":"string","example":"1527243092"},"date":{"type":"string","example":"20180529133026"},"login":{"type":"string","example":"user@email.com"},"description":{"type":"string","example":"Invoice 123 refund"},"status":{"type":"integer","example":3},"amount":{"type":"integer","example":100}},"type":"object"},"RefundsByDeteResponse200Details":{"properties":{"orderId":{"type":"integer","example":100101},"sessionId":{"type":"string","example":"unique sessionId"},"amount":{"type":"integer","example":100},"batchId":{"type":"integer","example":1001},"status":{"type":"integer","example":1},"requestId":{"type":"string","example":"unique requestId"},"statusTxt":{"type":"string","example":"completed"},"date":{"type":"string","example":"202001011232"}},"type":"object"},"RefundsByDeteResponse200":{"properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/RefundsByDeteResponse200Details"}},"responseCode":{"type":"string","example":"0"}},"type":"object"},"RefundsDetailsNotFoundResponse":{"properties":{"error":{"type":"string","example":"Refunds not found!"},"code":{"type":"number","example":404}},"type":"object"},"RefundsInfoResponse200Details":{"properties":{"orderId":{"type":"integer","example":100101},"sessionId":{"type":"string","example":"unique sessionId"},"amount":{"type":"integer","example":100},"batchId":{"type":"integer","example":1001},"status":{"type":"integer","example":1},"requestId":{"type":"string","example":"unique requestId"},"statusTxt":{"type":"string","example":"completed"},"date":{"type":"string","example":"202001011232"}},"type":"object"},"RefundsInfoResponse200":{"properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/RefundsInfoResponse200Details"}},"responseCode":{"type":"string","example":"0"}},"type":"object"},"ItemMarketplaceRefundRequestArrayData":{"properties":{"orderId":{"type":"integer","example":"1001"},"sessionId":{"type":"string","example":"zamowienie-1"},"merchantId":{"type":"string","example":"1001"},"items":{"type":"array","items":{"$ref":"#\/components\/schemas\/ItemMarketplaceCartRefundArrayData"}}},"type":"object"},"ItemMarketplaceCartRefundArrayData":{"properties":{"targetPosId":{"type":"integer","example":"1001"},"sessionId":{"type":"string","example":"zamowienie-1"},"description":{"type":"string","example":"refund description"},"amount":{"type":"integer","example":"100"}},"type":"object"},"TransactionRefundJsonRequestBody":{"properties":{"requestId":{"type":"string","example":"example"},"refunds":{"type":"array","items":{"$ref":"#\/components\/schemas\/RefundRequestArrayDataBasic"}},"refundsUuid":{"type":"string","example":"example"},"urlStatus":{"type":"string","example":"https:\/\/przelewy24.pl"}},"type":"object"},"RefundRequestArrayDataBasic":{"required":["orderId","sessionId","amount"],"properties":{"orderId":{"type":"integer","example":1001},"sessionId":{"type":"string","example":"zamowienie-1"},"amount":{"type":"integer","example":100},"description":{"type":"string","example":"zwrot za fakture 123"},"data":{"$ref":"#\/components\/schemas\/RequestedRefundList"}},"type":"object"},"TransactionRefund200":{"properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/TransactionRefund200Item"}},"responseCode":{"type":"string","example":"0"}},"type":"object"},"TransactionRefund409":{"properties":{"error":{"type":"array","items":{"$ref":"#\/components\/schemas\/TransactionRefund409Item"}},"code":{"type":"integer","example":409}},"type":"object"},"TransactionRefund409Item":{"properties":{"orderId":{"type":"integer","example":"1001"},"sessionId":{"type":"string","example":"zamowienie-1"},"amount":{"type":"integer","example":"101"},"description":{"type":"string","example":"zwrot za fakture 123"},"status":{"type":"boolean","example":false},"message":{"type":"string","example":"The amount of refund exceeds available amount for the transaction"},"data":{"$ref":"#\/components\/schemas\/RequestedRefundList"}},"type":"object"},"TransactionRefund200Item":{"properties":{"orderId":{"type":"integer","example":"1001"},"sessionId":{"type":"string","example":"zamowienie-1"},"amount":{"type":"integer","example":"100"},"description":{"type":"string","example":"zwrot za fakture 123","nullable":true},"status":{"type":"boolean","example":true},"message":{"type":"string","example":"success"},"data":{"$ref":"#\/components\/schemas\/RequestedRefundList"}},"type":"object"},"RequestedRefundList":{"type":"array","items":{"$ref":"#\/components\/schemas\/RequestedRefundData"}},"RequestedRefundData":{"properties":{"spId":{"type":"integer","example":10000},"spAmount":{"type":"integer","example":1}},"type":"object"},"MarketplaceItemParametersV1":{"required":["price","quantity","description","sessionId","sellerCategory","targetAmount","targetPosId"],"properties":{"price":{"type":"integer"},"quantity":{"type":"number","format":"double"},"description":{"type":"string"},"sessionId":{"type":"string"},"control":{"type":"string"},"sellerCategory":{"type":"string"},"targetAmount":{"type":"integer"},"targetPosId":{"type":"integer"}},"type":"object"},"MarketplaceTransactionRegisterV1":{"required":["merchantId","posId","sessionId","amount","currency","description","email","country","language","urlReturn","items","sign"],"properties":{"merchantId":{"description":"Merchant identification number","type":"integer"},"posId":{"description":"Shop identification number (defaults to merchant ID)","type":"integer"},"sessionId":{"description":"Unique identifier from merchant's system","type":"string","maxLength":100},"amount":{"description":"Transaction amount which format is presented as amount in given currency divided by 100 (AMOUNT\/100)","type":"integer"},"currency":{"description":"Currency","type":"string","maxLength":3},"description":{"description":"Transaction description","type":"string","maxLength":1024},"email":{"description":"Customer's e-mail","type":"string","maxLength":50},"client":{"description":"Customer's name and surname","type":"string","maxLength":50},"address":{"description":"Customer's address","type":"string","maxLength":80},"zip":{"description":"Customer's postal code","type":"string","maxLength":10},"city":{"description":"Customer's city","type":"string","maxLength":50},"country":{"description":"Customer's country","type":"string","maxLength":2},"phone":{"description":"Customer's phone number","type":"string","maxLength":2},"language":{"description":"Language in format xx","type":"string"},"method":{"description":"List of payment methods can be found in merchant panel or accessed by API","type":"integer","maxLength":2},"urlReturn":{"description":"URL address to which customer will be redirected when transaction is complete","type":"string","maxLength":250},"urlStatus":{"description":"URL address to which transaction status will be send","type":"string","maxLength":250},"urlNotify":{"description":"URL address to which notify message will be send","type":"string","maxLength":250},"timeLimit":{"description":"Time limit for transaction process, 0 - no limit, max. 99 (in minutes)","type":"integer"},"channel":{"description":"1 - card, 2 - transfer, 4 - traditional transfer, 8 - N\/A, 16 - all 24\/7, 32 - prepayment","type":"integer","enum":["1","2","4","8","16","32"]},"shipping":{"description":"Delivery cost","type":"integer"},"transferLabel":{"description":"Description that appears in transfer title (required for card payment, PayPal, FerBuy)","type":"string","maxLength":20},"sdkVersion":{"description":"Version of mobile library. Determines if transaction is mobile.","type":"string"},"sign":{"description":"Control sum *","type":"string"},"encoding":{"description":"Encoding: ISO-8859-2, UTF-8, Windows-1250","type":"string"},"items":{"description":"Items list","type":"array","items":{"$ref":"#\/components\/schemas\/MarketplaceItemParametersV1"}},"methodRefId":{"description":"Method reference number used for fast payments","type":"string"}},"type":"object"},"MarketplaceTransactionRegisterSimpV1":{"required":["merchantId","posId","sessionId","amount","currency","description","email","country","language","urlReturn","items","sign","simpCountryCode"],"properties":{"merchantId":{"description":"Merchant identification number","type":"integer"},"posId":{"description":"Shop identification number (defaults to merchant ID)","type":"integer"},"sessionId":{"description":"Unique identifier from merchant's system","type":"string","maxLength":100},"amount":{"description":"Transaction amount which format is presented as amount in given currency divided by 100 (AMOUNT\/100)","type":"integer"},"currency":{"description":"Currency","type":"string","maxLength":3},"description":{"description":"Transaction description","type":"string","maxLength":1024},"email":{"description":"Customer's e-mail","type":"string","maxLength":50},"client":{"description":"Customer's name and surname","type":"string","maxLength":50},"address":{"description":"Customer's address","type":"string","maxLength":80},"zip":{"description":"Customer's postal code","type":"string","maxLength":10},"city":{"description":"Customer's city","type":"string","maxLength":50},"country":{"description":"Customer's country","type":"string","maxLength":2},"phone":{"description":"Customer's phone number","type":"string","maxLength":2},"language":{"description":"Language in format xx","type":"string"},"method":{"description":"List of payment methods can be found in merchant panel or accessed by API","type":"integer","maxLength":2},"urlReturn":{"description":"URL address to which customer will be redirected when transaction is complete","type":"string","maxLength":250},"urlStatus":{"description":"URL address to which transaction status will be send","type":"string","maxLength":250},"urlNotify":{"description":"URL address to which notify message will be send","type":"string","maxLength":250},"timeLimit":{"description":"Time limit for transaction process, 0 - no limit, max. 99 (in minutes)","type":"integer"},"channel":{"description":"1 - card, 2 - transfer, 4 - traditional transfer, 8 - N\/A, 16 - all 24\/7, 32 - prepayment","type":"integer","enum":["1","2","4","8","16","32"]},"shipping":{"description":"Delivery cost","type":"integer"},"transferLabel":{"description":"Description that appears in transfer title (required for card payment, PayPal, FerBuy)","type":"string","maxLength":20},"sdkVersion":{"description":"Version of mobile library. Determines if transaction is mobile.","type":"string"},"sign":{"description":"Control sum *","type":"string"},"encoding":{"description":"Encoding: ISO-8859-2, UTF-8, Windows-1250","type":"string"},"items":{"description":"Items list","type":"array","items":{"$ref":"#\/components\/schemas\/MarketplaceItemParametersV1"}},"methodRefId":{"description":"Method reference number used for fast payments","type":"string"},"simpClientId":{"description":"SIMP client id","type":"string"},"simpCountryCode":{"description":"SIMP country code","type":"string"}},"type":"object"},"CartParameters":{"properties":{"sellerId":{"type":"string"},"sellerCategory":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"quantity":{"type":"integer"},"price":{"type":"integer"},"number":{"type":"string"}},"type":"object"},"SplitPaymentDetailsParameters":{"required":["vatAmount","invoiceNumber","nip","iban"],"properties":{"vatAmount":{"type":"integer"},"invoiceNumber":{"type":"string"},"nip":{"type":"string"},"iban":{"type":"string"}},"type":"object"},"SplitTransactionRegister":{"required":["merchantId","posId","sessionId","amount","currency","description","email","country","language","urlReturn","sign"],"properties":{"merchantId":{"description":"Merchant identification number","type":"integer"},"posId":{"description":"Shop identification number (defaults to merchant ID)","type":"integer"},"sessionId":{"description":"Unique identifier from merchant's system","type":"string","maxLength":100},"amount":{"description":"Transaction amount which format is presented as amount in given currency divided by 100 (AMOUNT\/100)","type":"integer"},"currency":{"description":"Currency","type":"string","maxLength":3},"description":{"description":"Transaction description","type":"string","maxLength":1024},"email":{"description":"Customer's e-mail","type":"string","maxLength":50},"client":{"description":"Customer's name and surname","type":"string","maxLength":50},"address":{"description":"Customer's address","type":"string","maxLength":80},"zip":{"description":"Customer's postal code","type":"string","maxLength":10},"city":{"description":"Customer's city","type":"string","maxLength":50},"country":{"description":"Customer's country","type":"string","maxLength":2},"phone":{"description":"Customer's phone number","type":"string","maxLength":2},"language":{"description":"Language in format xx","type":"string","maxLength":2},"method":{"description":"List of payment methods can be found in merchant panel or accessed by API","type":"integer","maxLength":2},"urlReturn":{"description":"URL address to which customer will be redirected when transaction is complete","type":"string","maxLength":250},"urlStatus":{"description":"URL address to which transaction status will be send","type":"string","maxLength":250},"urlNotify":{"description":"URL address to which notify message will be send","type":"string","maxLength":250},"timeLimit":{"description":"Time limit for transaction process, 0 - no limit, max. 99 (in minutes)","type":"integer"},"channel":{"description":"1 - card, 2 - transfer, 4 - traditional transfer, 8 - N\/A, 16 - all 24\/7, 32 - prepayment","type":"integer","enum":["1","2","4","8","16","32"]},"shipping":{"description":"Delivery cost","type":"integer"},"transferLabel":{"description":"Description that appears in transfer title (required for card payment, PayPal, FerBuy)","type":"string","maxLength":20},"sdkVersion":{"description":"Version of mobile library. Determines if transaction is mobile.","type":"string"},"sign":{"description":"Control sum *","type":"string"},"encoding":{"description":"Encoding: ISO-8859-2, UTF-8, Windows-1250","type":"string"},"cart":{"description":"Shopping list<b>sellerId - seller id from partners system<\/b><br\/><b>sellerCategory - seller category from partners system<\/b><br\/>name - item name<br\/>description - additional item description<br\/>quantity - number of items<br\/>price - item unit price<br\/>number - item id from partners system","type":"array","items":{"$ref":"#\/components\/schemas\/CartParameters"}},"methodRefId":{"description":"Method reference number used for fast payments","type":"string"},"splitPaymentDetails":{"description":"","type":"array","items":{"$ref":"#\/components\/schemas\/SplitPaymentDetailsParameters"}}},"type":"object"},"CardDataParameters":{"required":["means"],"properties":{"means":{"properties":{"card":{"required":["pan","expYear","expMonth"],"properties":{"pan":{"description":"card number, format: 1234123412341234","type":"string","example":"1234123412341234"},"expYear":{"type":"integer","example":2025},"expMonth":{"type":"integer","example":2},"clientName":{"type":"string"},"securityCode":{"description":"cvv\/cvc","type":"string","example":"012"}},"type":"object"},"schemeToken":{"required":["pan","expYear","expMonth","type"],"properties":{"pan":{"description":"card number, format: 1234123412341234","type":"string","example":"1234123412341234"},"expYear":{"type":"integer","example":2025},"expMonth":{"type":"integer","example":2},"securityCode":{"description":"cvv\/cvc","type":"string","example":"012"},"eci":{"type":"string"},"type":{"type":"string","enum":["visaToken","mcToken","visaMobile","applepay","googlepay"],"example":"googlepay"}},"type":"object"},"referenceNumber":{"required":["id"],"properties":{"id":{"type":"string"},"securityCode":{"description":"cvv\/cvc","type":"string","example":"012"}},"type":"object"},"xPayPayload":{"required":["payload","type"],"properties":{"payload":{"description":"base64 payload","type":"string"},"type":{"description":"","type":"string","enum":["applepay","googlepay"]}},"type":"object"}},"type":"object"},"transactionType":{"type":"string","default":"standard","enum":["standard","initial","1click","recurring"]},"traceId":{"description":"required when transactionType is recurring and property card or schemeToken was used","type":"string"},"3dsMode":{"type":"string","default":"3ds","enum":["3ds","SCA","lowValue","LSRequired","tra","exemption","noPreference"]}},"type":"object"},"TransactionRegister":{"required":["merchantId","posId","sessionId","amount","currency","description","email","country","language","urlReturn","sign"],"properties":{"merchantId":{"description":"Merchant identification number","type":"integer"},"posId":{"description":"Shop identification number (defaults to merchant ID)","type":"integer"},"sessionId":{"description":"Unique identifier from merchant's system","type":"string","maxLength":100},"amount":{"description":"Transaction amount which format is presented as amount in given currency divided by 100 (AMOUNT\/100)","type":"integer"},"currency":{"description":"Currency","type":"string","maxLength":3},"description":{"description":"Transaction description","type":"string","maxLength":1024},"email":{"description":"Customer's e-mail","type":"string","maxLength":50},"client":{"description":"Customer's name and surname","type":"string","maxLength":50},"address":{"description":"Customer's address","type":"string","maxLength":80},"zip":{"description":"Customer's postal code","type":"string","maxLength":10},"city":{"description":"Customer's city","type":"string","maxLength":50},"country":{"description":"Customer's country","type":"string","maxLength":2},"phone":{"description":"Customer's phone number","type":"string","maxLength":2},"language":{"description":"Language in format xx","type":"string"},"method":{"description":"List of payment methods can be found in merchant panel or accessed by API","type":"integer","maxLength":2},"urlReturn":{"description":"URL address to which customer will be redirected when transaction is complete","type":"string","maxLength":250},"urlStatus":{"description":"URL address to which transaction status will be send","type":"string","maxLength":250},"urlNotify":{"description":"URL address to which notify message will be send","type":"string","maxLength":250},"timeLimit":{"description":"Time limit for transaction process, 0 - no limit, max. 99 (in minutes)","type":"integer"},"channel":{"description":"1 - card, 2 - transfer, 4 - traditional transfer, 8 - N\/A, 16 - all 24\/7, 32 - prepayment","type":"integer","enum":["1","2","4","8","16","32"]},"shipping":{"description":"Delivery cost","type":"integer"},"transferLabel":{"description":"Description that appears in transfer title (required for card payment, PayPal, FerBuy)","type":"string","maxLength":20},"sdkVersion":{"description":"Version of mobile library. Determines if transaction is mobile.","type":"string"},"sign":{"description":"Control sum *","type":"string"},"encoding":{"description":"Encoding: ISO-8859-2, UTF-8, Windows-1250","type":"string"},"cart":{"description":"Shopping list\n     *    <b>sellerId - seller id from partners system<\/b><br\/>\n     *    <b>sellerCategory - seller category from partners system<\/b><br\/>\n     *    name - item name<br\/>\n     *    description - additional item description<br\/>\n     *    quantity - number of items<br\/>\n     *    price - item unit price<br\/>\n     *    number - item id from partners system","type":"array","items":{"$ref":"#\/components\/schemas\/CartParameters"}},"methodRefId":{"description":"Method reference number used for fast payments","type":"string"},"cardData":{"type":"object","$ref":"#\/components\/schemas\/CardDataParameters"}},"type":"object"},"TransactionRegisterSimpV1":{"required":["merchantId","posId","sessionId","amount","currency","description","email","country","language","urlReturn","sign"],"properties":{"merchantId":{"description":"Merchant identification number","type":"integer"},"posId":{"description":"Shop identification number (defaults to merchant ID)","type":"integer"},"sessionId":{"description":"Unique identifier from merchant's system","type":"string","maxLength":100},"amount":{"description":"Transaction amount which format is presented as amount in given currency divided by 100 (AMOUNT\/100)","type":"integer"},"currency":{"description":"Currency","type":"string","maxLength":3},"description":{"description":"Transaction description","type":"string","maxLength":1024},"email":{"description":"Customer's e-mail","type":"string","maxLength":50},"client":{"description":"Customer's name and surname","type":"string","maxLength":50},"address":{"description":"Customer's address","type":"string","maxLength":80},"zip":{"description":"Customer's postal code","type":"string","maxLength":10},"city":{"description":"Customer's city","type":"string","maxLength":50},"country":{"description":"Customer's country","type":"string","maxLength":2},"phone":{"description":"Customer's phone number","type":"string","maxLength":2},"language":{"description":"Language in format xx","type":"string"},"method":{"description":"List of payment methods can be found in merchant panel or accessed by API","type":"integer","maxLength":2},"urlReturn":{"description":"URL address to which customer will be redirected when transaction is complete","type":"string","maxLength":250},"urlStatus":{"description":"URL address to which transaction status will be send","type":"string","maxLength":250},"urlNotify":{"description":"URL address to which notify message will be send","type":"string","maxLength":250},"timeLimit":{"description":"Time limit for transaction process, 0 - no limit, max. 99 (in minutes)","type":"integer"},"channel":{"description":"1 - card, 2 - transfer, 4 - traditional transfer, 8 - N\/A, 16 - all 24\/7, 32 - prepayment","type":"integer","enum":["1","2","4","8","16","32"]},"shipping":{"description":"Delivery cost","type":"integer"},"transferLabel":{"description":"Description that appears in transfer title (required for card payment, PayPal, FerBuy)","type":"string","maxLength":20},"sdkVersion":{"description":"Version of mobile library. Determines if transaction is mobile.","type":"string"},"sign":{"description":"Control sum *","type":"string"},"encoding":{"description":"Encoding: ISO-8859-2, UTF-8, Windows-1250","type":"string"},"methodRefId":{"description":"Method reference number used for fast payments","type":"string"},"cardData":{"type":"object","$ref":"#\/components\/schemas\/CardDataParameters"},"simpClientId":{"description":"SIMP client id","type":"string"},"simpCountryCode":{"description":"SIMP country code","type":"string"}},"type":"object"},"TransactionRegisterTTL":{"required":["merchantId","posId","sessionId","amount","currency","description","email","country","language","urlReturn","sign","ttl"],"properties":{"merchantId":{"description":"Merchant identification number","type":"integer"},"posId":{"description":"Shop identification number (defaults to merchant ID)","type":"integer"},"sessionId":{"description":"Unique identifier from merchant's system","type":"string","maxLength":100},"amount":{"description":"Transaction amount which format is presented as amount in given currency divided by 100 (AMOUNT\/100)","type":"integer"},"currency":{"description":"Currency","type":"string","maxLength":3},"description":{"description":"Transaction description","type":"string","maxLength":1024},"email":{"description":"Customer's e-mail","type":"string","maxLength":50},"client":{"description":"Customer's name and surname","type":"string","maxLength":50},"address":{"description":"Customer's address","type":"string","maxLength":80},"zip":{"description":"Customer's postal code","type":"string","maxLength":10},"city":{"description":"Customer's city","type":"string","maxLength":50},"country":{"description":"Customer's country","type":"string","maxLength":2},"phone":{"description":"Customer's phone number","type":"string","maxLength":2},"language":{"description":"Language in format xx","type":"string"},"method":{"description":"List of payment methods can be found in merchant panel or accessed by API","type":"integer","maxLength":2},"urlReturn":{"description":"URL address to which customer will be redirected when transaction is complete","type":"string","maxLength":250},"urlStatus":{"description":"URL address to which transaction status will be send","type":"string","maxLength":250},"urlNotify":{"description":"URL address to which notify message will be send","type":"string","maxLength":250},"timeLimit":{"description":"Time limit for transaction process, 0 - no limit, max. 99 (in minutes)","type":"integer"},"ttl":{"description":"Time limit for transaction token , 0 = max 31 days, max. 44640 (in minutes)","type":"integer"},"channel":{"description":"1 - card, 2 - transfer, 4 - traditional transfer, 8 - N\/A, 16 - all 24\/7, 32 - prepayment","type":"integer","enum":["1","2","4","8","16","32"]},"shipping":{"description":"Delivery cost","type":"integer"},"transferLabel":{"description":"Description that appears in transfer title (required for card payment, PayPal, FerBuy)","type":"string","maxLength":20},"sdkVersion":{"description":"Version of mobile library. Determines if transaction is mobile.","type":"string"},"sign":{"description":"Control sum *","type":"string"},"encoding":{"description":"Encoding: ISO-8859-2, UTF-8, Windows-1250","type":"string"},"cart":{"description":"Shopping list\n     *    <b>sellerId - seller id from partners system<\/b><br\/>\n     *    <b>sellerCategory - seller category from partners system<\/b><br\/>\n     *    name - item name<br\/>\n     *    description - additional item description<br\/>\n     *    quantity - number of items<br\/>\n     *    price - item unit price<br\/>\n     *    number - item id from partners system","type":"array","items":{"$ref":"#\/components\/schemas\/CartParameters"}},"methodRefId":{"description":"Method reference number used for fast payments","type":"string"}},"type":"object"},"TransactionRegistrationResponse":{"properties":{"data":{"properties":{"token":{"type":"string","default":"1A2B3C4D5E-A1B2C3-A1B2C3-1A2B3C4D5E"}},"type":"object"},"responseCode":{"type":"string","default":"0"}},"type":"object"},"TransactionRegisterOfflineRequest":{"properties":{"token":{"type":"string","example":"0000000000-000000-000000-0000000000"}},"type":"object"},"TransactionRegistrationOffline200":{"properties":{"data":{"properties":{"orderId":{"type":"integer","example":123123},"sessionId":{"type":"string","example":"order123"},"amount":{"type":"integer","example":1000},"currency":{"type":"string","example":"PLN"},"statement":{"type":"string","example":"P24-A12-A12-A12"},"iban":{"type":"string","example":"PL00000000000000000000000000"},"ibanOwner":{"type":"string","example":"Firma S.A."},"ibanOwnerAddress":{"type":"string","example":"Adres 00-000, Ulica 123"}},"type":"object"},"responseCode":{"type":"string","example":"0"}},"type":"object"},"TransactionRegistrationOffline409":{"properties":{"error":{"type":"string","enum":["Currency not supported","Too large amount","Client is blacklisted","Unable to find data for given transaction tokenno","Unable to create offline transaction","Unknown error"]},"code":{"type":"number","example":0}},"type":"object"},"TransactionRejectJsonRequestBody":{"properties":{"orderId":{"type":"integer","example":1001},"sessionId":{"type":"string","example":"zamowienie-1"}},"type":"object"},"TransactionRejectJsonRequestBodyV11":{"allOf":[{"$ref":"#\/components\/schemas\/TransactionRejectJsonRequestBody"},{"properties":{"orderId":{"type":"integer","example":1001},"sessionId":{"type":"string","example":"zamowienie-1"},"sign":{"type":"string","example":"0a7ad99c127c137382291c6c5e8477a0b5a303e1a182946d7a95cdf0e3888568"}},"type":"object"}]},"TransactionReject200":{"properties":{"data":{"properties":{"status":{"type":"string","example":"success"}},"type":"object"},"responseCode":{"type":"string","example":"0"}},"type":"object"},"TransactionVerificationResponse":{"properties":{"data":{"properties":{"status":{"type":"string","default":"success"}},"type":"object"},"responseCode":{"type":"string","default":"0"}},"type":"object"},"MoveBalance409":{"properties":{"error":{"type":"string","example":"Unable to withdraw merchant balance from express"},"code":{"type":"integer","example":409}},"type":"object"},"MoveBalance422":{"properties":{"error":{"type":"string","example":"Merchants are not related"},"code":{"type":"integer","example":422}},"type":"object"},"MoveBalance201":{"properties":{"data":{"$ref":"#\/components\/schemas\/MoveBalanceData"},"responseCode":{"type":"integer","example":0}},"type":"object"},"MoveBalanceData":{"properties":{"orderId":{"description":"Order id created at completed transaction process","type":"integer"}},"type":"object"},"TransferRecharge409":{"properties":{"error":{"type":"string","example":"Insufficient funds available"},"code":{"type":"integer","example":409}},"type":"object"},"TransferRecharge404":{"properties":{"error":{"type":"string","example":"Merchant not found"},"code":{"type":"integer","example":404}},"type":"object"},"TransferRecharge201":{"properties":{"data":{"$ref":"#\/components\/schemas\/TransferRechargeData"},"responseCode":{"type":"integer","example":0}},"type":"object"},"TransferRechargeData":{"properties":{"sessionId":{"description":"merchant unique sessionId","type":"string"},"transferId":{"description":"transfer id","type":"string"}},"type":"object"},"UserCreateJsonRequestBody":{"properties":{"userId":{"type":"string","example":"unikalny-identyfikator-uzytkownika"},"email":{"type":"string","example":"unikalny-adres@example.com"},"firstName":{"type":"string","example":"Jan"},"lastName":{"type":"string","example":"Kowalski"},"city":{"type":"string","example":"Pozna\u0144"},"country":{"type":"string","example":"Poland"},"regulationAcceptanceDate":{"type":"integer","example":"1498381559"}},"type":"object"},"UserCreateResponse200":{"properties":{"data":{"properties":{"p24UserId":{"type":"integer","example":1001}},"type":"object"},"responseCode":{"type":"string","example":"0"}},"type":"object"},"UserCreateResponse409":{"properties":{"error":{"type":"string","example":"User already exists"},"code":{"type":"number","example":409}},"type":"object"},"GeneratePaymentMethodsResponse":{"properties":{"data":{"properties":{"paymentMethods":{"type":"array","items":{"properties":{"methodId":{"type":"integer"},"name":{"type":"string"},"group":{"type":"string"},"enabled":{"type":"boolean"},"imgUrl":{"type":"string"},"mobileImgUrl":{"type":"string"},"jsUrl":{"type":"string"},"mobile":{"type":"boolean"}},"type":"object"}},"lastPaymentMethods":{"type":"array","items":{"properties":{"methodId":{"type":"integer","example":"218"},"lastUsageDate":{"type":"string","example":"2017-06-27 14:16:41"}},"type":"object"}},"cardsNumbers":{"type":"array","items":{"properties":{"methodId":{"type":"integer","example":"218"},"refId":{"type":"string","example":"6E29F61E-DD699159-E324BA71-FB8AC28B"},"maskedCardNumber":{"type":"string","example":"xxxxxxxx0001"},"expirationDate":{"type":"string","example":"01\/2020"},"cardName":{"type":"string","example":"visa"},"enabled":{"type":"boolean"},"imgUrl":{"type":"string","example":"https:\/\/static.przelewy24.pl\/img\/card\/visa.png"},"mobileImgUrl":{"type":"string","example":"https:\/\/static.przelewy24.pl\/img\/card\/visa.png"}},"type":"object"}},"temporaryCardsNumbers":{"type":"array","items":{"properties":{"refId":{"type":"string","example":"P24CCTMP-5B295BC6-BBA153A2-6D661B7D"},"maskedCardNumber":{"type":"string","example":"xxxxxxxx1013"},"expirationDate":{"type":"string","example":"12\/2017"},"cardName":{"type":"string","example":"mastercard"},"visibilityTo":{"type":"integer","example":"1498980269"},"store":{"type":"boolean"},"imgUrl":{"type":"string","example":"https:\/\/static.przelewy24.pl\/img\/card\/mastercard.png"},"mobileImgUrl":{"type":"string","example":"https:\/\/static.przelewy24.pl\/img\/card\/mastercard.png"}},"type":"object"}},"paymentAliases":{"type":"array","items":{"properties":{"methodId":{"type":"integer"},"alias":{"type":"string"}},"type":"object"}}},"type":"object"}},"type":"object"},"ErrorCodeResponse":{"properties":{"error":{"type":"string","example":"Undefined error"},"code":{"type":"integer","example":500}},"type":"object"},"InvalidInputData":{"properties":{"error":{"type":"string","enum":["Invalid input data","Invalid request"]},"code":{"type":"number","example":400}},"type":"object"}},"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}}}}