{"openapi":"3.1.0","info":{"title":"API","description":"Payment gate and page API"},"servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"tags":[{"name":"/paymentpageapi","description":"Payment page link creation"},{"name":"/balances-v2","description":"Balance operations"},{"name":"/card","description":"Card operations"}],"paths":{"/paymentpageapi/{siteId}/create_payment_link":{"post":{"tags":["/paymentpageapi"],"operationId":"createPaymentLink","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLinkCreationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/{operationId}/reversal":{"post":{"tags":["/card"],"operationId":"reversal","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}},{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/{operationId}/refund":{"post":{"tags":["/card"],"operationId":"refund","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}},{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/{operationId}/refresh":{"post":{"tags":["/card"],"operationId":"recheckStatus","parameters":[{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/card/{siteId}/operations/{operationId}/queuecallback":{"post":{"tags":["/card"],"operationId":"queueCallback","parameters":[{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/card/{siteId}/operations/{operationId}/purchase":{"post":{"tags":["/card"],"operationId":"preparedPurchase","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}},{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreparedPurchaseRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/{operationId}/postprovider":{"post":{"tags":["/card"],"operationId":"executePostProviderActions","parameters":[{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/card/{siteId}/operations/{operationId}/decline":{"post":{"tags":["/card"],"operationId":"decline","parameters":[{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/card/{siteId}/operations/{operationId}/completep2p":{"post":{"tags":["/card"],"operationId":"completeP2p","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}},{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteP2PRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/{operationId}/complete3dsValidate":{"post":{"tags":["/card"],"operationId":"complete3dsValidate","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}},{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complete3ds2ValidateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/{operationId}/complete3dsAuth":{"post":{"tags":["/card"],"operationId":"complete3dsAuth","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}},{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complete3ds2AuthRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/{operationId}/complete3ds":{"post":{"tags":["/card"],"operationId":"complete3ds","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}},{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complete3dsRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/{operationId}/capture":{"post":{"tags":["/card"],"operationId":"capture","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}},{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/{operationId}/auth":{"post":{"tags":["/card"],"operationId":"preparedAuth","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}},{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreparedPurchaseRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/recurring":{"post":{"tags":["/card"],"operationId":"recurring","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/purchase":{"post":{"tags":["/card"],"operationId":"purchase","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/prepare/purchase":{"post":{"tags":["/card"],"operationId":"preparePurchase","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationCreationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/prepare/auth":{"post":{"tags":["/card"],"operationId":"prepareAuth","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationCreationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/payout":{"post":{"tags":["/card"],"operationId":"payout","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/p2p":{"post":{"tags":["/card"],"operationId":"p2p","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/P2PRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/auth":{"post":{"tags":["/card"],"operationId":"auth","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/{operationId}":{"get":{"tags":["/card"],"operationId":"status","parameters":[{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+-\\w+-\\d+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/card/{siteId}/operations/status":{"get":{"tags":["/card"],"operationId":"statusByExternalId","parameters":[{"name":"externalId","in":"query","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+-\\d+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializableApiResponse"}}}}}}},"/balances-v2/{merchantId}/{siteId}":{"get":{"tags":["/balances-v2"],"operationId":"siteBalances","parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BalanceResponseV2"}}}}}}}},"/balances-v2/{merchantId}":{"get":{"tags":["/balances-v2"],"operationId":"siteBalances_1","parameters":[{"name":"merchantId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BalanceResponseV2"}}}}}}}}},"components":{"schemas":{"MerchantParameters":{"type":"object","properties":{"param1":{"type":"string","example":1,"maxLength":250},"param2":{"type":"string","example":2,"maxLength":250},"param3":{"type":"string","example":3,"maxLength":250}}},"MonetaryAmount":{"type":"object","properties":{"currency":{"type":"string","example":"RUB","pattern":"^[A-Z]{3}$"},"amount":{"type":"number","example":10.0}},"required":["amount","currency"]},"Notification":{"type":"object","properties":{"url":{"type":"string","example":"https://example.com/callback"},"version":{"type":"integer","format":"int32","example":2}},"required":["url"]},"PageParameters":{"type":"object","properties":{"urlOnSuccess":{"type":"string","example":"https://example.com/success"},"urlOnDecline":{"type":"string","example":"https://example.com/decline"},"description":{"type":"string","example":"my order"}},"required":["description","urlOnDecline","urlOnSuccess"]},"PaymentLinkCreationRequest":{"type":"object","properties":{"notification":{"$ref":"#/components/schemas/Notification"},"externalId":{"type":"string"},"amount":{"$ref":"#/components/schemas/MonetaryAmount"},"registerRecurring":{"type":"boolean"},"action":{"type":"string","enum":["auth","purchase"]},"merchantParameters":{"$ref":"#/components/schemas/MerchantParameters"},"pageParameters":{"$ref":"#/components/schemas/PageParameters"},"customerId":{"type":"string"},"customerPhoneNumber":{"type":"string","pattern":"^[0-9]{7,15}$"},"customerEmail":{"type":"string","pattern":"^.*@.*$"},"customerName":{"type":"string"},"customerIp":{"type":"string","pattern":"^[0-9/.]{7,15}$"}},"required":["action","merchantParameters","notification","pageParameters"]},"SerializableApiResponse":{},"SimpleRequest":{"type":"object","properties":{"notification":{"$ref":"#/components/schemas/Notification"},"externalId":{"type":"string"},"merchantParameters":{"$ref":"#/components/schemas/MerchantParameters"}},"required":["merchantParameters","notification"]},"RefundRequest":{"type":"object","properties":{"notification":{"$ref":"#/components/schemas/Notification"},"externalId":{"type":"string"},"amount":{"$ref":"#/components/schemas/MonetaryAmount"},"merchantParameters":{"$ref":"#/components/schemas/MerchantParameters"}},"required":["merchantParameters","notification"]},"Card":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodDTOEntity"},{"type":"object","properties":{"pan":{"type":"string","example":4111111111111111,"minLength":1},"expMonth":{"type":"integer","format":"int32","example":12,"maximum":12,"minimum":1},"expYear":{"type":"integer","format":"int32","example":2020,"maximum":2050,"minimum":2018},"cvv":{"type":"string","example":123,"minLength":1,"pattern":"[0-9]{3}"}}}],"description":"Card with cvv","required":["cvv","pan"]},"Payer":{"type":"object","properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentMethodDTO"},"info":{"type":"object","additionalProperties":{"type":"string"}}}},"PaymentMethodDTO":{"type":"object","properties":{"entity":{"oneOf":[{"$ref":"#/components/schemas/Card"},{"$ref":"#/components/schemas/RecurringTokenDTO"}]}},"required":["entity"]},"PaymentMethodDTOEntity":{"description":"Look at concrete implementation: Card, NoCvvCard, RecurringTokenDTO"},"PreparedPurchaseRequest":{"type":"object","properties":{"payer":{"$ref":"#/components/schemas/Payer"},"saveCard":{"type":"boolean"}},"required":["payer"]},"RecurringTokenDTO":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodDTOEntity"},{"type":"object","properties":{"id":{"type":"string","example":"1-22","minLength":1}}}],"description":"Recurring token","required":["id"]},"CaptchaRotations":{"type":"object","properties":{"rotations":{"type":"array","example":"0, 1, 2, 3, 0, 1, 0, 3, 1","items":{"type":"integer","format":"int32"}}}},"CompleteP2PRequest":{"type":"object","properties":{"type":{"type":"string","enum":["CAPTCHA_ROTATIONS"]},"entity":{"$ref":"#/components/schemas/CaptchaRotations"}},"required":["entity","type"]},"Complete3ds2ValidateRequest":{"type":"object","properties":{"cres":{"type":"string","minLength":1}},"required":["cres"]},"Complete3ds2AuthRequest":{"type":"object","properties":{"threeDSServerTransID":{"type":"string","minLength":1},"info":{"type":"object","additionalProperties":{"type":"string"}}},"required":["info","threeDSServerTransID"]},"Complete3dsRequest":{"type":"object","properties":{"paRes":{"type":"string","minLength":1}},"required":["paRes"]},"CaptureRequest":{"type":"object","properties":{"notification":{"$ref":"#/components/schemas/Notification"},"externalId":{"type":"string"},"amount":{"$ref":"#/components/schemas/MonetaryAmount"},"merchantParameters":{"$ref":"#/components/schemas/MerchantParameters"}},"required":["merchantParameters","notification"]},"RecurringRequest":{"type":"object","properties":{"notification":{"$ref":"#/components/schemas/Notification"},"externalId":{"type":"string"},"amount":{"$ref":"#/components/schemas/MonetaryAmount"},"payer":{"$ref":"#/components/schemas/Payer"},"merchantParameters":{"$ref":"#/components/schemas/MerchantParameters"}},"required":["merchantParameters","notification","payer"]},"PurchaseRequest":{"type":"object","properties":{"notification":{"$ref":"#/components/schemas/Notification"},"externalId":{"type":"string"},"amount":{"$ref":"#/components/schemas/MonetaryAmount"},"payer":{"$ref":"#/components/schemas/Payer"},"merchantParameters":{"$ref":"#/components/schemas/MerchantParameters"},"registerRecurring":{"type":"boolean"},"tds":{"type":"object","additionalProperties":{"type":"string"}}},"required":["merchantParameters","notification","payer"]},"OperationCreationRequest":{"type":"object","properties":{"notification":{"$ref":"#/components/schemas/Notification"},"externalId":{"type":"string"},"amount":{"$ref":"#/components/schemas/MonetaryAmount"},"merchantParameters":{"$ref":"#/components/schemas/MerchantParameters"},"registerRecurring":{"type":"boolean"},"customerId":{"type":"string"}},"required":["merchantParameters","notification"]},"PayoutRequest":{"type":"object","properties":{"notification":{"$ref":"#/components/schemas/Notification"},"externalId":{"type":"string"},"amount":{"$ref":"#/components/schemas/MonetaryAmount"},"receiver":{"$ref":"#/components/schemas/Receiver"},"merchantParameters":{"$ref":"#/components/schemas/MerchantParameters"}},"required":["merchantParameters","notification","receiver"]},"Receiver":{"type":"object","properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentMethodDTO"},"name":{"type":"string","example":"IVAN","maxLength":24,"minLength":1,"pattern":"^[a-zA-Z0-9\\\\.\\\\\"\\\\*\\\\,\\\\/\\\\:\\\\;\\\\=\\\\_\\s-]+$"},"surname":{"type":"string","example":"IVANOV","maxLength":24,"minLength":1,"pattern":"^[a-zA-Z0-9\\\\.\\\\\"\\\\*\\\\,\\\\/\\\\:\\\\;\\\\=\\\\_\\s-]+$"},"info":{"type":"object","additionalProperties":{"type":"string"}}},"required":["name","surname"]},"P2PRequest":{"type":"object","properties":{"notification":{"$ref":"#/components/schemas/Notification"},"externalId":{"type":"string"},"amount":{"$ref":"#/components/schemas/MonetaryAmount"},"payer":{"$ref":"#/components/schemas/Payer"},"merchantParameters":{"$ref":"#/components/schemas/MerchantParameters"},"pageParameters":{"$ref":"#/components/schemas/PageParameters"}},"required":["merchantParameters","notification","payer"]},"BalanceResponseV2":{"type":"object","properties":{"financialProcessingId":{"type":"integer","format":"int32"},"siteId":{"type":"string"},"value":{"type":"number"},"availableValue":{"type":"number"},"currency":{"type":"string"}}}}}}