{ "openapi": "3.1.0", "info": { "title": "Processing API", "version": "dev", "description": "Server-to-server API" }, "servers": [ { "url": "https://sandbox.payneteasy.eu", "description": "Current server" } ], "paths": { "/api/3ds/v1/upload-cres-result/{endpointId}": { "post": { "description": "RequestOperation: TDS_UPLOAD_CRES_RESULT.\n\ncontrol \u003d SHA-1(login + client-order-id + orderid + merchant_control_key)", "operationId": "/api/3ds/v1/upload-cres-result", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TdsCResResultRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/3ds/v1/upload-method-url-result/{endpointId}": { "post": { "description": "RequestOperation: TDS_UPLOAD_METHOD_URL_RESULT.\n\ncontrol \u003d SHA-1(login + client-order-id + orderid + merchant_control_key)", "operationId": "/api/3ds/v1/upload-method-url-result", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TdsMethodUrlResultRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/3ds/v1/upload-pares-result/{endpointId}": { "post": { "description": "RequestOperation: TDS_UPLOAD_PARES_RESULT.\n\ncontrol \u003d SHA-1(login + client-order-id + orderid + merchant_control_key)", "operationId": "/api/3ds/v1/upload-pares-result", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TdsPaResResultRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/account-verification-form/{endpointId}": { "post": { "description": "RequestOperation: ACCOUNT_VERIFICATION_FORM.\n\ncontrol \u003d SHA-1(endpointId + client_orderid + email + merchant_control_key)", "operationId": "/api/v2/account-verification-form", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AccountVerificationFormRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncCheckoutFormRedirect" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/account-verification/{endpointId}": { "post": { "description": "RequestOperation: ACCOUNT_VERIFICATION.\n\ncontrol \u003d SHA-1(endpointId + client_orderid + email + merchant_control_key)", "operationId": "/api/v2/account-verification", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AccountVerificationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/capture/{endpointId}": { "post": { "description": "RequestOperation: CAPTURE.\n\ncontrol \u003d SHA-1(login + client_orderid + orderid + amount + currency + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "operationId": "/api/v2/capture", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CaptureRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/create-card-ref/{endpointId}": { "post": { "description": "RequestOperation: CARDREF.\n\ncontrol \u003d SHA-1(login + client_orderid + orderid + merchant_control_key)", "operationId": "/api/v2/create-card-ref", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateCardRefRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/CardRefAsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/get-card-info/{endpointId}": { "post": { "description": "RequestOperation: CARDINFO.", "operationId": "/api/v2/get-card-info", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/GetCardInfoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/CardInfoAsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/make-rebill/{endpointId}": { "post": { "description": "RequestOperation: REBILL.\n\ncontrol \u003d SHA-1(login + client_orderid + cardrefid + amount + currency + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "operationId": "/api/v2/make-rebill", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RebillRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/payment-form/{endpointId}": { "post": { "description": "RequestOperation: PAYMENTFORM.", "operationId": "/api/v2/payment-form", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PaymentFormRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncCheckoutFormRedirect" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/payout-form/{endpointId}": { "post": { "description": "RequestOperation: PAYOUTFORM.", "operationId": "/api/v2/payout-form", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PayoutFormRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncCheckoutFormRedirect" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/payout/{endpointId}": { "post": { "description": "RequestOperation: PAYOUT.\n\nSigned with OAuth 1.0a, signature method: HMAC-SHA1 (profile: hmac-sha1). All oauth_* parameters are sent in the Authorization header, not in the form body. Required parameters: oauth_consumer_key (merchant login), oauth_signature_method (HMAC-SHA1), oauth_signature, oauth_timestamp, oauth_nonce, oauth_version (1.0).", "operationId": "/api/v2/payout", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PayoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } }, "x-pne-oauth1": { "version": "1.0", "profile": "hmac-sha1", "signature_method": "HMAC-SHA1", "transport": "authorization-header", "oauth_parameters": [ "oauth_consumer_key", "oauth_signature_method", "oauth_signature", "oauth_timestamp", "oauth_nonce", "oauth_version" ], "consumer_key": { "source": "merchant-login" }, "signing_key": { "type": "hmac-shared-secret", "source": "merchant_control_key" }, "base_string": { "spec": "RFC 5849 §3.4.1", "method_and_url": "HTTP method + normalized URL (no default ports)", "parameters": "oauth_* + URL query + application/x-www-form-urlencoded body" } } } }, "/api/v2/preauth-form/{endpointId}": { "post": { "description": "RequestOperation: PREAUTHFORM.\n\ncontrol \u003d SHA-1(endpointId + client_orderid + amount + email + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "operationId": "/api/v2/preauth-form", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AuthFormRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncCheckoutFormRedirect" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/preauth/{endpointId}": { "post": { "description": "RequestOperation: PREAUTH.\n\ncontrol \u003d SHA-1(endpointId + client_orderid + amount + email + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "operationId": "/api/v2/preauth", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AuthRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/return/{endpointId}": { "post": { "description": "RequestOperation: RETURN.\n\ncontrol \u003d SHA-1(login + client_orderid + orderid + amount + currency + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "operationId": "/api/v2/return", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReturnRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/sale-form/{endpointId}": { "post": { "description": "RequestOperation: SALEFORM.\n\ncontrol \u003d SHA-1(endpointId + client_orderid + amount + email + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "operationId": "/api/v2/sale-form", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SaleFormRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncCheckoutFormRedirect" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/sale/{endpointId}": { "post": { "description": "RequestOperation: SALE.\n\ncontrol \u003d SHA-1(endpointId + client_orderid + amount + email + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "operationId": "/api/v2/sale", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SaleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/status/{endpointId}": { "post": { "description": "RequestOperation: STATUS.\n\ncontrol \u003d SHA-1(login + client_orderid + orderid + merchant_control_key)", "operationId": "/api/v2/status", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/StatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v2/void/{endpointId}": { "post": { "description": "RequestOperation: VOID.\n\ncontrol \u003d SHA-1(login + client_orderid + orderid + merchant_control_key)", "operationId": "/api/v2/void", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/VoidRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } } } }, "/api/v4/create-card-ref/{endpointId}": { "post": { "description": "RequestOperation: CARDREF_V4.\n\nSigned with OAuth 1.0a, signature method: RSA-SHA256 (profile: rsa-sha256). All oauth_* parameters are sent in the Authorization header, not in the form body. Required parameters: oauth_consumer_key (merchant login), oauth_signature_method (RSA-SHA256), oauth_signature, oauth_timestamp, oauth_nonce, oauth_version (1.0).", "operationId": "/api/v4/create-card-ref", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateCardRefV4Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/CardRefV4AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } }, "x-pne-oauth1": { "version": "1.0", "profile": "rsa-sha256", "signature_method": "RSA-SHA256", "transport": "authorization-header", "oauth_parameters": [ "oauth_consumer_key", "oauth_signature_method", "oauth_signature", "oauth_timestamp", "oauth_nonce", "oauth_version" ], "consumer_key": { "source": "merchant-login" }, "signing_key": { "type": "rsa-private-key", "format": "PEM", "min_strength_bits": 2048, "server_verifies_with": "rsa-public-key" }, "base_string": { "spec": "RFC 5849 §3.4.1", "method_and_url": "HTTP method + normalized URL (no default ports)", "parameters": "oauth_* + URL query + application/x-www-form-urlencoded body" } } } }, "/api/v4/create-recurring-payment/{endpointId}": { "post": { "description": "RequestOperation: CREATE_RP_V4.\n\nSigned with OAuth 1.0a, signature method: RSA-SHA256 (profile: rsa-sha256). All oauth_* parameters are sent in the Authorization header, not in the form body. Required parameters: oauth_consumer_key (merchant login), oauth_signature_method (RSA-SHA256), oauth_signature, oauth_timestamp, oauth_nonce, oauth_version (1.0).", "operationId": "/api/v4/create-recurring-payment", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RecurringPaymentForCreation" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/CreateRecurringPaymentResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } }, "x-pne-oauth1": { "version": "1.0", "profile": "rsa-sha256", "signature_method": "RSA-SHA256", "transport": "authorization-header", "oauth_parameters": [ "oauth_consumer_key", "oauth_signature_method", "oauth_signature", "oauth_timestamp", "oauth_nonce", "oauth_version" ], "consumer_key": { "source": "merchant-login" }, "signing_key": { "type": "rsa-private-key", "format": "PEM", "min_strength_bits": 2048, "server_verifies_with": "rsa-public-key" }, "base_string": { "spec": "RFC 5849 §3.4.1", "method_and_url": "HTTP method + normalized URL (no default ports)", "parameters": "oauth_* + URL query + application/x-www-form-urlencoded body" } } } }, "/api/v4/payout-check/{endpointId}": { "post": { "description": "RequestOperation: PAYOUT_V4_CHECK.\n\nSigned with OAuth 1.0a, signature method: RSA-SHA256 (profile: rsa-sha256). All oauth_* parameters are sent in the Authorization header, not in the form body. Required parameters: oauth_consumer_key (merchant login), oauth_signature_method (RSA-SHA256), oauth_signature, oauth_timestamp, oauth_nonce, oauth_version (1.0).", "operationId": "/api/v4/payout-check", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PayoutCheckRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } }, "x-pne-oauth1": { "version": "1.0", "profile": "rsa-sha256", "signature_method": "RSA-SHA256", "transport": "authorization-header", "oauth_parameters": [ "oauth_consumer_key", "oauth_signature_method", "oauth_signature", "oauth_timestamp", "oauth_nonce", "oauth_version" ], "consumer_key": { "source": "merchant-login" }, "signing_key": { "type": "rsa-private-key", "format": "PEM", "min_strength_bits": 2048, "server_verifies_with": "rsa-public-key" }, "base_string": { "spec": "RFC 5849 §3.4.1", "method_and_url": "HTTP method + normalized URL (no default ports)", "parameters": "oauth_* + URL query + application/x-www-form-urlencoded body" } } } }, "/api/v4/payout-pay/{endpointId}": { "post": { "description": "RequestOperation: PAYOUT_V4_PAY.\n\nSigned with OAuth 1.0a, signature method: RSA-SHA256 (profile: rsa-sha256). All oauth_* parameters are sent in the Authorization header, not in the form body. Required parameters: oauth_consumer_key (merchant login), oauth_signature_method (RSA-SHA256), oauth_signature, oauth_timestamp, oauth_nonce, oauth_version (1.0).", "operationId": "/api/v4/payout-pay", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PayoutPayRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } }, "x-pne-oauth1": { "version": "1.0", "profile": "rsa-sha256", "signature_method": "RSA-SHA256", "transport": "authorization-header", "oauth_parameters": [ "oauth_consumer_key", "oauth_signature_method", "oauth_signature", "oauth_timestamp", "oauth_nonce", "oauth_version" ], "consumer_key": { "source": "merchant-login" }, "signing_key": { "type": "rsa-private-key", "format": "PEM", "min_strength_bits": 2048, "server_verifies_with": "rsa-public-key" }, "base_string": { "spec": "RFC 5849 §3.4.1", "method_and_url": "HTTP method + normalized URL (no default ports)", "parameters": "oauth_* + URL query + application/x-www-form-urlencoded body" } } } }, "/api/v4/payout/{endpointId}": { "post": { "description": "RequestOperation: PAYOUT_V4.\n\nSigned with OAuth 1.0a, signature method: RSA-SHA256 (profile: rsa-sha256). All oauth_* parameters are sent in the Authorization header, not in the form body. Required parameters: oauth_consumer_key (merchant login), oauth_signature_method (RSA-SHA256), oauth_signature, oauth_timestamp, oauth_nonce, oauth_version (1.0).", "operationId": "/api/v4/payout", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PayoutV4Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } }, "x-pne-oauth1": { "version": "1.0", "profile": "rsa-sha256", "signature_method": "RSA-SHA256", "transport": "authorization-header", "oauth_parameters": [ "oauth_consumer_key", "oauth_signature_method", "oauth_signature", "oauth_timestamp", "oauth_nonce", "oauth_version" ], "consumer_key": { "source": "merchant-login" }, "signing_key": { "type": "rsa-private-key", "format": "PEM", "min_strength_bits": 2048, "server_verifies_with": "rsa-public-key" }, "base_string": { "spec": "RFC 5849 §3.4.1", "method_and_url": "HTTP method + normalized URL (no default ports)", "parameters": "oauth_* + URL query + application/x-www-form-urlencoded body" } } } }, "/api/v4/process-recurring-payment/{endpointId}": { "post": { "description": "RequestOperation: PROCESS_RP_V4.\n\nSigned with OAuth 1.0a, signature method: RSA-SHA256 (profile: rsa-sha256). All oauth_* parameters are sent in the Authorization header, not in the form body. Required parameters: oauth_consumer_key (merchant login), oauth_signature_method (RSA-SHA256), oauth_signature, oauth_timestamp, oauth_nonce, oauth_version (1.0).", "operationId": "/api/v4/process-recurring-payment", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RecurringPaymentToProcess" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ProcessRecurringPaymentResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } }, "x-pne-oauth1": { "version": "1.0", "profile": "rsa-sha256", "signature_method": "RSA-SHA256", "transport": "authorization-header", "oauth_parameters": [ "oauth_consumer_key", "oauth_signature_method", "oauth_signature", "oauth_timestamp", "oauth_nonce", "oauth_version" ], "consumer_key": { "source": "merchant-login" }, "signing_key": { "type": "rsa-private-key", "format": "PEM", "min_strength_bits": 2048, "server_verifies_with": "rsa-public-key" }, "base_string": { "spec": "RFC 5849 §3.4.1", "method_and_url": "HTTP method + normalized URL (no default ports)", "parameters": "oauth_* + URL query + application/x-www-form-urlencoded body" } } } }, "/api/v4/status/{endpointId}": { "post": { "description": "RequestOperation: STATUS.\n\nSigned with OAuth 1.0a, signature method: RSA-SHA256 (profile: rsa-sha256). All oauth_* parameters are sent in the Authorization header, not in the form body. Required parameters: oauth_consumer_key (merchant login), oauth_signature_method (RSA-SHA256), oauth_signature, oauth_timestamp, oauth_nonce, oauth_version (1.0).", "operationId": "/api/v4/status", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/StatusV4Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } }, "x-pne-oauth1": { "version": "1.0", "profile": "rsa-sha256", "signature_method": "RSA-SHA256", "transport": "authorization-header", "oauth_parameters": [ "oauth_consumer_key", "oauth_signature_method", "oauth_signature", "oauth_timestamp", "oauth_nonce", "oauth_version" ], "consumer_key": { "source": "merchant-login" }, "signing_key": { "type": "rsa-private-key", "format": "PEM", "min_strength_bits": 2048, "server_verifies_with": "rsa-public-key" }, "base_string": { "spec": "RFC 5849 §3.4.1", "method_and_url": "HTTP method + normalized URL (no default ports)", "parameters": "oauth_* + URL query + application/x-www-form-urlencoded body" } } } }, "/api/v4/transfer-by-ref/{endpointId}": { "post": { "description": "RequestOperation: TRANSFER_V4.\n\nSigned with OAuth 1.0a, signature method: RSA-SHA256 (profile: rsa-sha256). All oauth_* parameters are sent in the Authorization header, not in the form body. Required parameters: oauth_consumer_key (merchant login), oauth_signature_method (RSA-SHA256), oauth_signature, oauth_timestamp, oauth_nonce, oauth_version (1.0).", "operationId": "/api/v4/transfer-by-ref", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TransferByRefV4Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } }, "x-pne-oauth1": { "version": "1.0", "profile": "rsa-sha256", "signature_method": "RSA-SHA256", "transport": "authorization-header", "oauth_parameters": [ "oauth_consumer_key", "oauth_signature_method", "oauth_signature", "oauth_timestamp", "oauth_nonce", "oauth_version" ], "consumer_key": { "source": "merchant-login" }, "signing_key": { "type": "rsa-private-key", "format": "PEM", "min_strength_bits": 2048, "server_verifies_with": "rsa-public-key" }, "base_string": { "spec": "RFC 5849 §3.4.1", "method_and_url": "HTTP method + normalized URL (no default ports)", "parameters": "oauth_* + URL query + application/x-www-form-urlencoded body" } } } }, "/api/v4/transfer/{endpointId}": { "post": { "description": "RequestOperation: TRANSFER_V4.\n\nSigned with OAuth 1.0a, signature method: RSA-SHA256 (profile: rsa-sha256). All oauth_* parameters are sent in the Authorization header, not in the form body. Required parameters: oauth_consumer_key (merchant login), oauth_signature_method (RSA-SHA256), oauth_signature, oauth_timestamp, oauth_nonce, oauth_version (1.0).", "operationId": "/api/v4/transfer", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TransferV4Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } }, "x-pne-oauth1": { "version": "1.0", "profile": "rsa-sha256", "signature_method": "RSA-SHA256", "transport": "authorization-header", "oauth_parameters": [ "oauth_consumer_key", "oauth_signature_method", "oauth_signature", "oauth_timestamp", "oauth_nonce", "oauth_version" ], "consumer_key": { "source": "merchant-login" }, "signing_key": { "type": "rsa-private-key", "format": "PEM", "min_strength_bits": 2048, "server_verifies_with": "rsa-public-key" }, "base_string": { "spec": "RFC 5849 §3.4.1", "method_and_url": "HTTP method + normalized URL (no default ports)", "parameters": "oauth_* + URL query + application/x-www-form-urlencoded body" } } } }, "/api/v4/update-recurring-payment/{endpointId}": { "post": { "description": "RequestOperation: UPDATE_RP_V4.\n\nSigned with OAuth 1.0a, signature method: RSA-SHA256 (profile: rsa-sha256). All oauth_* parameters are sent in the Authorization header, not in the form body. Required parameters: oauth_consumer_key (merchant login), oauth_signature_method (RSA-SHA256), oauth_signature, oauth_timestamp, oauth_nonce, oauth_version (1.0).", "operationId": "/api/v4/update-recurring-payment", "parameters": [ { "name": "endpointId", "in": "path", "description": "Endpoint identifier (also accepted as endpoint group identifier depending on the service method).", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept", "in": "header", "description": "Client must request application/vnd.pay+json explicitly.", "required": true, "schema": { "type": "string", "enum": [ "application/vnd.pay+json" ] } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RecurringPaymentForUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/UpdateRecurringPaymentResponse" } } } }, "400": { "description": "Validation error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/vnd.pay+json": { "schema": { "$ref": "#/components/schemas/ServerErrorResponse" } } } } }, "x-pne-oauth1": { "version": "1.0", "profile": "rsa-sha256", "signature_method": "RSA-SHA256", "transport": "authorization-header", "oauth_parameters": [ "oauth_consumer_key", "oauth_signature_method", "oauth_signature", "oauth_timestamp", "oauth_nonce", "oauth_version" ], "consumer_key": { "source": "merchant-login" }, "signing_key": { "type": "rsa-private-key", "format": "PEM", "min_strength_bits": 2048, "server_verifies_with": "rsa-public-key" }, "base_string": { "spec": "RFC 5849 §3.4.1", "method_and_url": "HTTP method + normalized URL (no default ports)", "parameters": "oauth_* + URL query + application/x-www-form-urlencoded body" } } } } }, "components": { "schemas": { "AccountVerificationFormRequest": { "properties": { "account_number": { "type": "string", "maxLength": 32 }, "address1": { "type": "string", "maxLength": 256, "description": "Required if all of these are empty: card_recurring_payment_id." }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_phone": { "type": "string", "maxLength": 32 }, "birthday": { "type": "string", "maxLength": 30 }, "card_insurance_agreement_amount": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_bonus": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_end_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_number": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_sell_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_start_date": { "type": "string", "maxLength": 256 }, "card_printed_name": { "type": "string" }, "card_recurring_payment_id": { "type": "integer", "format": "int64" }, "cardrefid": { "type": "integer", "maximum": 12, "format": "int64" }, "cell_phone": { "type": "string", "maxLength": 128 }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "city": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: card_recurring_payment_id." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "control": { "type": "string", "description": "control \u003d SHA-1(endpointId + client_orderid + email + merchant_control_key)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "path", "name": "endpointId" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "email" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "country": { "type": "string", "maxLength": 3, "description": "Required if all of these are empty: card_recurring_payment_id." }, "credit_card_number": { "type": "string", "pattern": "^\\d+$" }, "currency": { "type": "string" }, "customer_accept": { "type": "string", "maxLength": 512, "description": "Aliases: customer_browser_accept_header." }, "customer_accept_language": { "type": "string", "maxLength": 128, "description": "Aliases: customer_browser_accept_language." }, "customer_browser_color_depth": { "type": "integer", "maximum": 2, "minimum": 1, "format": "int32" }, "customer_browser_info": { "type": "boolean" }, "customer_browser_java_enabled": { "type": "boolean" }, "customer_browser_javascript_enabled": { "type": "boolean" }, "customer_browser_screen_height": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_screen_width": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_time_zone": { "type": "integer", "maximum": 5, "minimum": 1, "format": "int32" }, "customer_csid": { "type": "string", "maxLength": 16384 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "customer_localtime": { "type": "string", "maxLength": 128 }, "customer_screen_size": { "type": "string", "maxLength": 32, "description": "Aliases: customer_screen." }, "customer_user_agent": { "type": "string", "maxLength": 512, "description": "Aliases: customer_agent, customer_browser_user_agent." }, "cvv2": { "type": "string" }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "device_imei": { "type": "string", "maxLength": 32, "description": "Aliases: dapi_imei." }, "device_sn": { "type": "string", "maxLength": 64, "description": "Aliases: dapi_dsn." }, "driver_license": { "type": "string", "maxLength": 128 }, "email": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: card_recurring_payment_id." }, "expire_month": { "type": "string" }, "expire_year": { "type": "string" }, "first_name": { "type": "string", "maxLength": 128 }, "insurance_amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "insured_person_birthday": { "type": "string", "maxLength": 256 }, "insured_person_document_issue_date": { "type": "string", "maxLength": 256 }, "insured_person_document_issuer_code": { "type": "string", "maxLength": 32 }, "insured_person_document_issuer_name": { "type": "string", "maxLength": 256 }, "insured_person_document_number": { "type": "string", "maxLength": 256 }, "insured_person_document_series": { "type": "string", "maxLength": 256 }, "insured_person_email": { "type": "string", "maxLength": 256 }, "insured_person_first_name": { "type": "string", "maxLength": 256 }, "insured_person_last_name": { "type": "string", "maxLength": 256 }, "insured_person_middle_name": { "type": "string", "maxLength": 256 }, "insured_person_phone": { "type": "string", "maxLength": 256 }, "insured_person_registration_address": { "type": "string", "maxLength": 256 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "last_name": { "type": "string", "maxLength": 128 }, "maxmind_phone_code": { "type": "string", "maxLength": 4 }, "maxmind_phone_id": { "type": "string", "maxLength": 128 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "merchant_form_data": { "type": "string", "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.MerchantFormDataValidator." }, "middle_name": { "type": "string", "maxLength": 128 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "payment_method": { "type": "string", "maxLength": 256 }, "phone": { "type": "string", "maxLength": 128 }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "redirect_fail_url": { "type": "string" }, "redirect_success_url": { "type": "string" }, "redirect_url": { "type": "string", "maxLength": 1024 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "site_url": { "type": "string", "maxLength": 100 }, "ssn": { "type": "string", "maxLength": 32 }, "state": { "type": "string", "maxLength": 32 }, "tds_areq_notification_url": { "type": "string", "maxLength": 256, "minLength": 11, "description": "Aliases: tds_creq_notification_url, tds_cres_notification_url." }, "tds_authentication_result_authentication_type": { "type": "string", "maxLength": 2, "minLength": 2 }, "tds_authentication_result_authentication_value": { "type": "string", "maxLength": 28, "minLength": 19 }, "tds_authentication_result_message_version": { "type": "string", "maxLength": 5, "minLength": 5 }, "tds_authentication_result_transaction_id": { "type": "string", "maxLength": 36, "minLength": 19 }, "tds_authentication_result_transaction_status": { "type": "string", "maxLength": 1, "minLength": 1 }, "tds_authentication_result_type": { "type": "string", "maxLength": 6, "minLength": 6 }, "tds_challenge_window_size": { "type": "string", "maxLength": 11, "minLength": 2 }, "temporary_card_record_id": { "type": "string", "maxLength": 36 }, "zip_code": { "type": "string", "maxLength": 32, "description": "Required if all of these are empty: card_recurring_payment_id." } }, "type": "object", "required": [ "client_orderid", "control", "ipaddress", "order_desc" ] }, "AccountVerificationRequest": { "properties": { "account_number": { "type": "string", "maxLength": 32, "description": "Required if all of these are empty: credit_card_number, cardrefid, temporary_card_record_id, card_recurring_payment_id, phone." }, "address1": { "type": "string", "maxLength": 256, "description": "Required if all of these are empty: cardrefid, phone." }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_phone": { "type": "string", "maxLength": 32 }, "birthday": { "type": "string", "maxLength": 30 }, "card_insurance_agreement_amount": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_bonus": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_end_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_number": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_sell_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_start_date": { "type": "string", "maxLength": 256 }, "card_printed_name": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: account_number, cardrefid, phone." }, "card_recurring_payment_id": { "type": "integer", "format": "int64", "description": "Required if all of these are empty: credit_card_number, account_number, cardrefid, temporary_card_record_id, phone." }, "cardrefid": { "type": "integer", "maximum": 10, "format": "int64", "description": "Required if all of these are empty: credit_card_number, account_number, temporary_card_record_id, card_recurring_payment_id, phone." }, "cell_phone": { "type": "string", "maxLength": 128 }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "city": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: cardrefid, phone." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "control": { "type": "string", "description": "control \u003d SHA-1(endpointId + client_orderid + email + merchant_control_key)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "path", "name": "endpointId" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "email" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "country": { "type": "string", "maxLength": 3, "description": "Required if all of these are empty: cardrefid, phone." }, "credit_card_number": { "type": "string", "maxLength": 19, "pattern": "^\\d+$", "description": "Required if all of these are empty: account_number, cardrefid, temporary_card_record_id, card_recurring_payment_id, phone." }, "currency": { "type": "string", "maxLength": 3 }, "customer_accept": { "type": "string", "maxLength": 512, "description": "Aliases: customer_browser_accept_header." }, "customer_accept_language": { "type": "string", "maxLength": 128, "description": "Aliases: customer_browser_accept_language." }, "customer_browser_color_depth": { "type": "integer", "maximum": 2, "minimum": 1, "format": "int32" }, "customer_browser_info": { "type": "boolean" }, "customer_browser_java_enabled": { "type": "boolean" }, "customer_browser_javascript_enabled": { "type": "boolean" }, "customer_browser_screen_height": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_screen_width": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_time_zone": { "type": "integer", "maximum": 5, "minimum": 1, "format": "int32" }, "customer_csid": { "type": "string", "maxLength": 16384 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "customer_localtime": { "type": "string", "maxLength": 128 }, "customer_screen_size": { "type": "string", "maxLength": 32, "description": "Aliases: customer_screen." }, "customer_user_agent": { "type": "string", "maxLength": 512, "description": "Aliases: customer_agent, customer_browser_user_agent." }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3, "description": "Required if all of these are empty: cardrefid, account_number, temporary_card_record_id, card_recurring_payment_id, phone." }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "device_imei": { "type": "string", "maxLength": 32, "description": "Aliases: dapi_imei." }, "device_sn": { "type": "string", "maxLength": 64, "description": "Aliases: dapi_dsn." }, "driver_license": { "type": "string", "maxLength": 128 }, "email": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: card_recurring_payment_id." }, "expire_month": { "type": "string", "maxLength": 2, "description": "Required if all of these are empty: account_number, cardrefid, phone." }, "expire_year": { "type": "string", "maxLength": 4, "minLength": 2, "description": "Required if all of these are empty: account_number, cardrefid, phone." }, "first_name": { "type": "string", "maxLength": 128 }, "insurance_amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "insured_person_birthday": { "type": "string", "maxLength": 256 }, "insured_person_document_issue_date": { "type": "string", "maxLength": 256 }, "insured_person_document_issuer_code": { "type": "string", "maxLength": 32 }, "insured_person_document_issuer_name": { "type": "string", "maxLength": 256 }, "insured_person_document_number": { "type": "string", "maxLength": 256 }, "insured_person_document_series": { "type": "string", "maxLength": 256 }, "insured_person_email": { "type": "string", "maxLength": 256 }, "insured_person_first_name": { "type": "string", "maxLength": 256 }, "insured_person_last_name": { "type": "string", "maxLength": 256 }, "insured_person_middle_name": { "type": "string", "maxLength": 256 }, "insured_person_phone": { "type": "string", "maxLength": 256 }, "insured_person_registration_address": { "type": "string", "maxLength": 256 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "last_name": { "type": "string", "maxLength": 128 }, "maxmind_phone_code": { "type": "string", "maxLength": 4 }, "maxmind_phone_id": { "type": "string", "maxLength": 128 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "middle_name": { "type": "string", "maxLength": 128 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "payment_method": { "type": "string", "maxLength": 256 }, "phone": { "type": "string", "maxLength": 128 }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "redirect_fail_url": { "type": "string", "maxLength": 1024 }, "redirect_success_url": { "type": "string", "maxLength": 1024 }, "redirect_url": { "type": "string", "maxLength": 1024 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "site_url": { "type": "string", "maxLength": 100 }, "ssn": { "type": "string", "maxLength": 32 }, "state": { "type": "string", "maxLength": 32 }, "tds_areq_notification_url": { "type": "string", "maxLength": 256, "minLength": 11, "description": "Aliases: tds_creq_notification_url, tds_cres_notification_url." }, "tds_authentication_result_authentication_type": { "type": "string", "maxLength": 2, "minLength": 2 }, "tds_authentication_result_authentication_value": { "type": "string", "maxLength": 28, "minLength": 19 }, "tds_authentication_result_message_version": { "type": "string", "maxLength": 5, "minLength": 5 }, "tds_authentication_result_transaction_id": { "type": "string", "maxLength": 36, "minLength": 19 }, "tds_authentication_result_transaction_status": { "type": "string", "maxLength": 1, "minLength": 1 }, "tds_authentication_result_type": { "type": "string", "maxLength": 6, "minLength": 6 }, "tds_challenge_window_size": { "type": "string", "maxLength": 11, "minLength": 2 }, "temporary_card_record_id": { "type": "string", "maxLength": 36, "description": "Required if all of these are empty: credit_card_number, account_number, cardrefid, card_recurring_payment_id, phone." }, "zip_code": { "type": "string", "maxLength": 32, "description": "Required if all of these are empty: cardrefid, phone." } }, "type": "object", "required": [ "client_orderid", "control", "ipaddress", "order_desc" ] }, "AsyncCheckoutFormRedirect": { "properties": { "end-point-id": { "type": "integer", "format": "int64" }, "merchant-order-id": { "type": "string" }, "paynet-order-id": { "type": "integer", "format": "int64" }, "serial-number": { "type": "string", "format": "uuid", "description": "Request serial number; echoed back from the request envelope." } }, "type": "object", "required": [ "serial-number" ] }, "AsyncResponse": { "properties": { "end-point-id": { "type": "integer", "format": "int64" }, "merchant-order-id": { "type": "string" }, "paynet-order-id": { "type": "integer", "format": "int64" }, "serial-number": { "type": "string", "format": "uuid", "description": "Request serial number; echoed back from the request envelope." } }, "type": "object", "required": [ "serial-number" ] }, "AuthFormRequest": { "properties": { "address1": { "type": "string", "maxLength": 256, "description": "Required if all of these are empty: card_recurring_payment_id." }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_phone": { "type": "string", "maxLength": 32 }, "birthday": { "type": "string", "maxLength": 30 }, "card_insurance_agreement_amount": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_bonus": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_end_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_number": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_sell_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_start_date": { "type": "string", "maxLength": 256 }, "card_printed_name": { "type": "string", "maxLength": 128 }, "card_recurring_payment_id": { "type": "integer", "format": "int64" }, "cardrefid": { "type": "integer", "maximum": 12, "format": "int64" }, "cell_phone": { "type": "string", "maxLength": 128 }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "city": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: card_recurring_payment_id." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "control": { "type": "string", "description": "control \u003d SHA-1(endpointId + client_orderid + amount + email + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "path", "name": "endpointId" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "amount", "transform": "to-cents-integer" }, { "source": "field", "name": "email" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "country": { "type": "string", "maxLength": 3, "description": "Required if all of these are empty: card_recurring_payment_id." }, "credit_card_number": { "type": "string", "pattern": "^\\d+$" }, "currency": { "type": "string", "maxLength": 4 }, "customer_accept": { "type": "string", "maxLength": 512, "description": "Aliases: customer_browser_accept_header." }, "customer_accept_language": { "type": "string", "maxLength": 128, "description": "Aliases: customer_browser_accept_language." }, "customer_browser_color_depth": { "type": "integer", "maximum": 2, "minimum": 1, "format": "int32" }, "customer_browser_info": { "type": "boolean" }, "customer_browser_java_enabled": { "type": "boolean" }, "customer_browser_javascript_enabled": { "type": "boolean" }, "customer_browser_screen_height": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_screen_width": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_time_zone": { "type": "integer", "maximum": 5, "minimum": 1, "format": "int32" }, "customer_csid": { "type": "string", "maxLength": 16384 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "customer_localtime": { "type": "string", "maxLength": 128 }, "customer_screen_size": { "type": "string", "maxLength": 32, "description": "Aliases: customer_screen." }, "customer_user_agent": { "type": "string", "maxLength": 512, "description": "Aliases: customer_agent, customer_browser_user_agent." }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "device_imei": { "type": "string", "maxLength": 32, "description": "Aliases: dapi_imei." }, "device_sn": { "type": "string", "maxLength": 64, "description": "Aliases: dapi_dsn." }, "driver_license": { "type": "string", "maxLength": 128 }, "email": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: card_recurring_payment_id." }, "expire_month": { "type": "string", "maxLength": 2 }, "expire_year": { "type": "string", "maxLength": 4, "minLength": 2 }, "first_name": { "type": "string", "maxLength": 128 }, "insurance_amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "insured_person_birthday": { "type": "string", "maxLength": 256 }, "insured_person_document_issue_date": { "type": "string", "maxLength": 256 }, "insured_person_document_issuer_code": { "type": "string", "maxLength": 32 }, "insured_person_document_issuer_name": { "type": "string", "maxLength": 256 }, "insured_person_document_number": { "type": "string", "maxLength": 256 }, "insured_person_document_series": { "type": "string", "maxLength": 256 }, "insured_person_email": { "type": "string", "maxLength": 256 }, "insured_person_first_name": { "type": "string", "maxLength": 256 }, "insured_person_last_name": { "type": "string", "maxLength": 256 }, "insured_person_middle_name": { "type": "string", "maxLength": 256 }, "insured_person_phone": { "type": "string", "maxLength": 256 }, "insured_person_registration_address": { "type": "string", "maxLength": 256 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "last_name": { "type": "string", "maxLength": 128 }, "maximum-transaction-amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "maxmind_phone_code": { "type": "string", "maxLength": 4 }, "maxmind_phone_id": { "type": "string", "maxLength": 128 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "merchant_form_data": { "type": "string", "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.MerchantFormDataValidator." }, "middle_name": { "type": "string", "maxLength": 128 }, "minimum-transaction-amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "payment_method": { "type": "string", "maxLength": 256 }, "phone": { "type": "string", "maxLength": 128 }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "redirect_fail_url": { "type": "string" }, "redirect_success_url": { "type": "string" }, "redirect_url": { "type": "string", "maxLength": 1024 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "site_url": { "type": "string", "maxLength": 100 }, "ssn": { "type": "string", "maxLength": 32 }, "state": { "type": "string", "maxLength": 32 }, "tds_areq_notification_url": { "type": "string", "maxLength": 256, "minLength": 11, "description": "Aliases: tds_creq_notification_url, tds_cres_notification_url." }, "tds_authentication_result_authentication_type": { "type": "string", "maxLength": 2, "minLength": 2 }, "tds_authentication_result_authentication_value": { "type": "string", "maxLength": 28, "minLength": 19 }, "tds_authentication_result_message_version": { "type": "string", "maxLength": 5, "minLength": 5 }, "tds_authentication_result_transaction_id": { "type": "string", "maxLength": 36, "minLength": 19 }, "tds_authentication_result_transaction_status": { "type": "string", "maxLength": 1, "minLength": 1 }, "tds_authentication_result_type": { "type": "string", "maxLength": 6, "minLength": 6 }, "tds_challenge_window_size": { "type": "string", "maxLength": 11, "minLength": 2 }, "temporary_card_record_id": { "type": "string", "maxLength": 36 }, "zip_code": { "type": "string", "maxLength": 32, "description": "Required if all of these are empty: card_recurring_payment_id." } }, "type": "object", "required": [ "amount", "client_orderid", "control", "currency", "ipaddress", "order_desc" ] }, "AuthRequest": { "properties": { "address1": { "type": "string", "maxLength": 256, "description": "Required if all of these are empty: card_recurring_payment_id." }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_phone": { "type": "string", "maxLength": 32 }, "birthday": { "type": "string", "maxLength": 30 }, "card_insurance_agreement_amount": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_bonus": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_end_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_number": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_sell_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_start_date": { "type": "string", "maxLength": 256 }, "card_printed_name": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: payment_method, card_recurring_payment_id." }, "card_recurring_payment_id": { "type": "integer", "format": "int64" }, "cell_phone": { "type": "string", "maxLength": 128 }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "city": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: card_recurring_payment_id." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "control": { "type": "string", "description": "control \u003d SHA-1(endpointId + client_orderid + amount + email + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "path", "name": "endpointId" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "amount", "transform": "to-cents-integer" }, { "source": "field", "name": "email" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "country": { "type": "string", "maxLength": 3, "description": "Required if all of these are empty: card_recurring_payment_id." }, "credit_card_number": { "type": "string", "maxLength": 19, "pattern": "^\\d+$", "description": "Required if all of these are empty: temporary_card_record_id, card_recurring_payment_id, payment_method." }, "currency": { "type": "string", "maxLength": 4 }, "customer_accept": { "type": "string", "maxLength": 512, "description": "Aliases: customer_browser_accept_header." }, "customer_accept_language": { "type": "string", "maxLength": 128, "description": "Aliases: customer_browser_accept_language." }, "customer_browser_color_depth": { "type": "integer", "maximum": 2, "minimum": 1, "format": "int32" }, "customer_browser_info": { "type": "boolean" }, "customer_browser_java_enabled": { "type": "boolean" }, "customer_browser_javascript_enabled": { "type": "boolean" }, "customer_browser_screen_height": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_screen_width": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_time_zone": { "type": "integer", "maximum": 5, "minimum": 1, "format": "int32" }, "customer_csid": { "type": "string", "maxLength": 16384 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "customer_localtime": { "type": "string", "maxLength": 128 }, "customer_screen_size": { "type": "string", "maxLength": 32, "description": "Aliases: customer_screen." }, "customer_user_agent": { "type": "string", "maxLength": 512, "description": "Aliases: customer_agent, customer_browser_user_agent." }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3, "description": "Required if all of these are empty: temporary_card_record_id, card_recurring_payment_id." }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "device_imei": { "type": "string", "maxLength": 32, "description": "Aliases: dapi_imei." }, "device_sn": { "type": "string", "maxLength": 64, "description": "Aliases: dapi_dsn." }, "driver_license": { "type": "string", "maxLength": 128 }, "email": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: card_recurring_payment_id." }, "expire_month": { "type": "string", "maxLength": 2, "description": "Required if all of these are empty: payment_method, card_recurring_payment_id." }, "expire_year": { "type": "string", "maxLength": 4, "minLength": 2, "description": "Required if all of these are empty: payment_method, card_recurring_payment_id." }, "first_name": { "type": "string", "maxLength": 128 }, "insurance_amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "insured_person_birthday": { "type": "string", "maxLength": 256 }, "insured_person_document_issue_date": { "type": "string", "maxLength": 256 }, "insured_person_document_issuer_code": { "type": "string", "maxLength": 32 }, "insured_person_document_issuer_name": { "type": "string", "maxLength": 256 }, "insured_person_document_number": { "type": "string", "maxLength": 256 }, "insured_person_document_series": { "type": "string", "maxLength": 256 }, "insured_person_email": { "type": "string", "maxLength": 256 }, "insured_person_first_name": { "type": "string", "maxLength": 256 }, "insured_person_last_name": { "type": "string", "maxLength": 256 }, "insured_person_middle_name": { "type": "string", "maxLength": 256 }, "insured_person_phone": { "type": "string", "maxLength": 256 }, "insured_person_registration_address": { "type": "string", "maxLength": 256 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "last_name": { "type": "string", "maxLength": 128 }, "maxmind_phone_code": { "type": "string", "maxLength": 4 }, "maxmind_phone_id": { "type": "string", "maxLength": 128 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "middle_name": { "type": "string", "maxLength": 128 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "payment_method": { "type": "string", "maxLength": 256 }, "phone": { "type": "string", "maxLength": 128 }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "redirect_fail_url": { "type": "string" }, "redirect_success_url": { "type": "string" }, "redirect_url": { "type": "string", "maxLength": 1024 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "site_url": { "type": "string", "maxLength": 100 }, "ssn": { "type": "string", "maxLength": 32 }, "state": { "type": "string", "maxLength": 32 }, "tds_areq_notification_url": { "type": "string", "maxLength": 256, "minLength": 11, "description": "Aliases: tds_creq_notification_url, tds_cres_notification_url." }, "tds_authentication_result_authentication_type": { "type": "string", "maxLength": 2, "minLength": 2 }, "tds_authentication_result_authentication_value": { "type": "string", "maxLength": 28, "minLength": 19 }, "tds_authentication_result_message_version": { "type": "string", "maxLength": 5, "minLength": 5 }, "tds_authentication_result_transaction_id": { "type": "string", "maxLength": 36, "minLength": 19 }, "tds_authentication_result_transaction_status": { "type": "string", "maxLength": 1, "minLength": 1 }, "tds_authentication_result_type": { "type": "string", "maxLength": 6, "minLength": 6 }, "tds_challenge_window_size": { "type": "string", "maxLength": 11, "minLength": 2 }, "temporary_card_record_id": { "type": "string", "maxLength": 36 }, "zip_code": { "type": "string", "maxLength": 32, "description": "Required if all of these are empty: card_recurring_payment_id." } }, "type": "object", "required": [ "amount", "client_orderid", "control", "currency", "ipaddress", "order_desc" ] }, "CaptureRequest": { "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "control": { "type": "string", "description": "control \u003d SHA-1(login + client_orderid + orderid + amount + currency + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "field", "name": "login" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "orderid" }, { "source": "field", "name": "amount", "transform": "to-cents-integer" }, { "source": "field", "name": "currency" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "currency": { "type": "string" }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "login": { "type": "string" }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "orderid": { "type": "integer", "format": "int64" }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." } }, "type": "object", "required": [ "client_orderid", "control", "login", "orderid" ] }, "CardInfoAsyncResponse": { "properties": { "serial-number": { "type": "string", "format": "uuid", "description": "Request serial number; echoed back from the request envelope." } }, "type": "object", "required": [ "serial-number" ] }, "CardRefAsyncResponse": { "properties": { "card-ref-id": { "type": "integer", "format": "int64" }, "serial-number": { "type": "string", "format": "uuid", "description": "Request serial number; echoed back from the request envelope." }, "unq-card-ref-id": { "type": "integer", "format": "int64" } }, "type": "object", "required": [ "serial-number" ] }, "CardRefV4AsyncResponse": { "properties": { "card-ref-id": { "type": "integer", "format": "int64" }, "dst-card-ref-id": { "type": "integer", "format": "int64" }, "dst-recurring-payment-id": { "type": "integer", "format": "int64" }, "dst-unq-card-ref-id": { "type": "integer", "format": "int64" }, "recurring-payment-id": { "type": "integer", "format": "int64" }, "serial-number": { "type": "string", "format": "uuid", "description": "Request serial number; echoed back from the request envelope." }, "unq-card-ref-id": { "type": "integer", "format": "int64" } }, "type": "object", "required": [ "serial-number" ] }, "CreateCardRefRequest": { "properties": { "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "control": { "type": "string", "description": "control \u003d SHA-1(login + client_orderid + orderid + merchant_control_key)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "field", "name": "login" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "orderid" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "login": { "type": "string" }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "orderid": { "type": "integer", "format": "int64" }, "rebill_count": { "type": "integer", "format": "int64" }, "rebill_data": { "type": "string" }, "rebill_interval": { "type": "string" }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." } }, "type": "object", "required": [ "client_orderid", "control", "login", "orderid" ] }, "CreateCardRefV4Request": { "properties": { "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "login": { "type": "string" }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "orderid": { "type": "integer", "format": "int64" }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." } }, "type": "object", "required": [ "client_orderid", "orderid" ] }, "CreateRecurringPaymentResponse": { "properties": { "recurring-payment-id": { "type": "integer", "format": "int64" }, "serial-number": { "type": "string", "format": "uuid", "description": "Request serial number; echoed back from the request envelope." } }, "type": "object", "required": [ "serial-number" ] }, "GetCardInfoRequest": { "properties": { "cardrefid": { "type": "integer", "format": "int64" }, "client_orderid": { "type": "string", "maxLength": 128 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "login": { "type": "string" }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." } }, "type": "object", "required": [ "cardrefid", "login" ] }, "PaymentFormRequest": { "properties": { "address1": { "type": "string", "maxLength": 128 }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_phone": { "type": "string", "maxLength": 32 }, "birthday": { "type": "string", "maxLength": 30 }, "card_insurance_agreement_amount": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_bonus": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_end_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_number": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_sell_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_start_date": { "type": "string", "maxLength": 256 }, "card_printed_name": { "type": "string", "maxLength": 128 }, "card_recurring_payment_id": { "type": "integer", "format": "int64" }, "cardrefid": { "type": "integer", "maximum": 12, "format": "int64" }, "cell_phone": { "type": "string", "maxLength": 128 }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "city": { "type": "string", "maxLength": 128 }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "country": { "type": "string", "maxLength": 3 }, "credit_card_number": { "type": "string", "pattern": "^\\d+$" }, "currency": { "type": "string", "maxLength": 4 }, "customer_accept": { "type": "string", "maxLength": 512, "description": "Aliases: customer_browser_accept_header." }, "customer_accept_language": { "type": "string", "maxLength": 128, "description": "Aliases: customer_browser_accept_language." }, "customer_browser_color_depth": { "type": "integer", "maximum": 2, "minimum": 1, "format": "int32" }, "customer_browser_info": { "type": "boolean" }, "customer_browser_java_enabled": { "type": "boolean" }, "customer_browser_javascript_enabled": { "type": "boolean" }, "customer_browser_screen_height": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_screen_width": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_time_zone": { "type": "integer", "maximum": 5, "minimum": 1, "format": "int32" }, "customer_csid": { "type": "string", "maxLength": 16384 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "customer_localtime": { "type": "string", "maxLength": 128 }, "customer_screen_size": { "type": "string", "maxLength": 32, "description": "Aliases: customer_screen." }, "customer_user_agent": { "type": "string", "maxLength": 512, "description": "Aliases: customer_agent, customer_browser_user_agent." }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "device_imei": { "type": "string", "maxLength": 32, "description": "Aliases: dapi_imei." }, "device_sn": { "type": "string", "maxLength": 64, "description": "Aliases: dapi_dsn." }, "driver_license": { "type": "string", "maxLength": 128 }, "email": { "type": "string", "maxLength": 128 }, "expire_month": { "type": "string", "maxLength": 2 }, "expire_year": { "type": "string", "maxLength": 4, "minLength": 2 }, "first_name": { "type": "string", "maxLength": 128 }, "insurance_amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "insured_person_birthday": { "type": "string", "maxLength": 256 }, "insured_person_document_issue_date": { "type": "string", "maxLength": 256 }, "insured_person_document_issuer_code": { "type": "string", "maxLength": 32 }, "insured_person_document_issuer_name": { "type": "string", "maxLength": 256 }, "insured_person_document_number": { "type": "string", "maxLength": 256 }, "insured_person_document_series": { "type": "string", "maxLength": 256 }, "insured_person_email": { "type": "string", "maxLength": 256 }, "insured_person_first_name": { "type": "string", "maxLength": 256 }, "insured_person_last_name": { "type": "string", "maxLength": 256 }, "insured_person_middle_name": { "type": "string", "maxLength": 256 }, "insured_person_phone": { "type": "string", "maxLength": 256 }, "insured_person_registration_address": { "type": "string", "maxLength": 256 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "last_name": { "type": "string", "maxLength": 128 }, "maxmind_phone_code": { "type": "string", "maxLength": 4 }, "maxmind_phone_id": { "type": "string", "maxLength": 128 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "merchant_form_data": { "type": "string", "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.MerchantFormDataValidator." }, "middle_name": { "type": "string", "maxLength": 128 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "payment_method": { "type": "string", "maxLength": 256 }, "phone": { "type": "string", "maxLength": 128 }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "redirect_fail_url": { "type": "string" }, "redirect_success_url": { "type": "string" }, "redirect_url": { "type": "string", "maxLength": 1024 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "site_url": { "type": "string", "maxLength": 100 }, "ssn": { "type": "string", "maxLength": 32 }, "state": { "type": "string", "maxLength": 4 }, "tds_areq_notification_url": { "type": "string", "maxLength": 256, "minLength": 11, "description": "Aliases: tds_creq_notification_url, tds_cres_notification_url." }, "tds_authentication_result_authentication_type": { "type": "string", "maxLength": 2, "minLength": 2 }, "tds_authentication_result_authentication_value": { "type": "string", "maxLength": 28, "minLength": 19 }, "tds_authentication_result_message_version": { "type": "string", "maxLength": 5, "minLength": 5 }, "tds_authentication_result_transaction_id": { "type": "string", "maxLength": 36, "minLength": 19 }, "tds_authentication_result_transaction_status": { "type": "string", "maxLength": 1, "minLength": 1 }, "tds_authentication_result_type": { "type": "string", "maxLength": 6, "minLength": 6 }, "tds_challenge_window_size": { "type": "string", "maxLength": 11, "minLength": 2 }, "temporary_card_record_id": { "type": "string", "maxLength": 36 }, "zip_code": { "type": "string", "maxLength": 32 } }, "type": "object", "required": [ "amount", "client_orderid", "currency", "ipaddress", "order_desc" ] }, "PayoutCheckRequest": { "properties": { "account_name": { "type": "string", "maxLength": 512 }, "account_number": { "type": "string", "maxLength": 64 }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_address1": { "type": "string", "maxLength": 256 }, "bank_area": { "type": "string", "maxLength": 128 }, "bank_bic": { "type": "string", "maxLength": 128 }, "bank_branch": { "type": "string", "maxLength": 512 }, "bank_city": { "type": "string", "maxLength": 128 }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_name": { "type": "string", "maxLength": 512 }, "bank_province": { "type": "string", "maxLength": 128 }, "bank_zip_code": { "type": "string", "maxLength": 32 }, "card_printed_name": { "type": "string", "maxLength": 128 }, "card_recurring_payment_id": { "type": "integer", "format": "int64" }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "credit_card_number": { "type": "string", "maxLength": 19, "pattern": "^\\d+$" }, "crypto_wallet_address": { "type": "string", "maxLength": 64 }, "currency": { "type": "string", "maxLength": 4 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "ewallet_type": { "type": "string", "maxLength": 64 }, "ewallet_wallet": { "type": "string", "maxLength": 128 }, "expire_month": { "type": "string", "maxLength": 2 }, "expire_year": { "type": "string", "maxLength": 4, "minLength": 2 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "legal_person_document_number": { "type": "string", "maxLength": 128 }, "legal_person_document_type": { "type": "string", "maxLength": 128 }, "legal_person_name": { "type": "string", "maxLength": 128 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "receiver_address1": { "type": "string", "maxLength": 256, "description": "Aliases: address1." }, "receiver_birthday": { "type": "string", "maxLength": 30, "description": "Aliases: birthday." }, "receiver_city": { "type": "string", "maxLength": 128, "description": "Aliases: city." }, "receiver_country_code": { "type": "string", "maxLength": 3, "description": "Aliases: country." }, "receiver_email": { "type": "string", "maxLength": 128, "description": "Aliases: email." }, "receiver_first_name": { "type": "string", "maxLength": 128, "description": "Aliases: first_name." }, "receiver_identity_document_id": { "type": "string", "maxLength": 128, "description": "Aliases: identity_document_id." }, "receiver_identity_document_number": { "type": "string", "maxLength": 16, "description": "Aliases: identity_document_number." }, "receiver_last_name": { "type": "string", "maxLength": 128, "description": "Aliases: last_name." }, "receiver_middle_name": { "type": "string", "maxLength": 128, "description": "Aliases: middle_name." }, "receiver_phone": { "type": "string", "maxLength": 128, "description": "Aliases: phone." }, "receiver_state": { "type": "string", "maxLength": 4, "description": "Aliases: state." }, "receiver_tin": { "type": "string", "maxLength": 128, "description": "Aliases: receiver_inn." }, "receiver_zip_code": { "type": "string", "maxLength": 32, "description": "Aliases: zip_code." }, "redirect_url": { "type": "string", "maxLength": 1024 }, "routing_number": { "type": "string", "maxLength": 32 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "temporary_card_record_id": { "type": "string", "maxLength": 36 } }, "type": "object", "required": [ "amount", "client_orderid", "currency" ] }, "PayoutFormRequest": { "properties": { "account_name": { "type": "string", "maxLength": 512 }, "account_number": { "type": "string", "maxLength": 32 }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_address1": { "type": "string", "maxLength": 256 }, "bank_area": { "type": "string", "maxLength": 128 }, "bank_bic": { "type": "string", "maxLength": 128 }, "bank_branch": { "type": "string", "maxLength": 512 }, "bank_cardno": { "type": "string", "maxLength": 128 }, "bank_city": { "type": "string", "maxLength": 128 }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_name": { "type": "string", "maxLength": 512 }, "bank_phone": { "type": "string", "maxLength": 32 }, "bank_province": { "type": "string", "maxLength": 128 }, "bank_zip_code": { "type": "string", "maxLength": 32 }, "card_insurance_agreement_amount": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_bonus": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_end_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_number": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_sell_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_start_date": { "type": "string", "maxLength": 256 }, "card_printed_name": { "type": "string", "maxLength": 128 }, "card_recurring_payment_id": { "type": "integer", "format": "int64" }, "cardrefid": { "type": "integer", "maximum": 12, "format": "int64" }, "cell_phone": { "type": "string", "maxLength": 128 }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "credit_card_number": { "type": "string", "pattern": "^\\d+$" }, "crypto_wallet_address": { "type": "string", "maxLength": 64 }, "currency": { "type": "string", "maxLength": 4 }, "customer_accept": { "type": "string", "maxLength": 512, "description": "Aliases: customer_browser_accept_header." }, "customer_accept_language": { "type": "string", "maxLength": 128, "description": "Aliases: customer_browser_accept_language." }, "customer_browser_color_depth": { "type": "integer", "maximum": 2, "minimum": 1, "format": "int32" }, "customer_browser_info": { "type": "boolean" }, "customer_browser_java_enabled": { "type": "boolean" }, "customer_browser_javascript_enabled": { "type": "boolean" }, "customer_browser_screen_height": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_screen_width": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_time_zone": { "type": "integer", "maximum": 5, "minimum": 1, "format": "int32" }, "customer_csid": { "type": "string", "maxLength": 16384 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "customer_localtime": { "type": "string", "maxLength": 128 }, "customer_screen_size": { "type": "string", "maxLength": 32, "description": "Aliases: customer_screen." }, "customer_user_agent": { "type": "string", "maxLength": 512, "description": "Aliases: customer_agent, customer_browser_user_agent." }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "device_imei": { "type": "string", "maxLength": 32, "description": "Aliases: dapi_imei." }, "device_sn": { "type": "string", "maxLength": 64, "description": "Aliases: dapi_dsn." }, "driver_license": { "type": "string", "maxLength": 128 }, "ewallet_type": { "type": "string", "maxLength": 64 }, "ewallet_wallet": { "type": "string", "maxLength": 128 }, "expire_month": { "type": "string", "maxLength": 2 }, "expire_year": { "type": "string", "maxLength": 4, "minLength": 2 }, "insurance_amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "insured_person_birthday": { "type": "string", "maxLength": 256 }, "insured_person_document_issue_date": { "type": "string", "maxLength": 256 }, "insured_person_document_issuer_code": { "type": "string", "maxLength": 32 }, "insured_person_document_issuer_name": { "type": "string", "maxLength": 256 }, "insured_person_document_number": { "type": "string", "maxLength": 256 }, "insured_person_document_series": { "type": "string", "maxLength": 256 }, "insured_person_email": { "type": "string", "maxLength": 256 }, "insured_person_first_name": { "type": "string", "maxLength": 256 }, "insured_person_last_name": { "type": "string", "maxLength": 256 }, "insured_person_middle_name": { "type": "string", "maxLength": 256 }, "insured_person_phone": { "type": "string", "maxLength": 256 }, "insured_person_registration_address": { "type": "string", "maxLength": 256 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "legal_person_document_number": { "type": "string", "maxLength": 128 }, "legal_person_document_type": { "type": "string", "maxLength": 128 }, "legal_person_name": { "type": "string", "maxLength": 128 }, "maxmind_phone_code": { "type": "string", "maxLength": 4 }, "maxmind_phone_id": { "type": "string", "maxLength": 128 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "merchant_form_data": { "type": "string", "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.MerchantFormDataValidator." }, "middle_name": { "type": "string", "maxLength": 128 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "payment_method": { "type": "string", "maxLength": 256 }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "receiver_address1": { "type": "string", "maxLength": 256, "description": "Aliases: address1." }, "receiver_birthday": { "type": "string", "maxLength": 30, "description": "Aliases: birthday." }, "receiver_city": { "type": "string", "maxLength": 128, "description": "Aliases: city." }, "receiver_country_code": { "type": "string", "maxLength": 3, "description": "Aliases: country." }, "receiver_email": { "type": "string", "maxLength": 128, "description": "Aliases: email." }, "receiver_first_name": { "type": "string", "maxLength": 128, "description": "Aliases: first_name." }, "receiver_identity_document_id": { "type": "string", "maxLength": 128, "description": "Aliases: identity_document_id." }, "receiver_identity_document_number": { "type": "string", "maxLength": 128, "description": "Aliases: identity_document_number." }, "receiver_last_name": { "type": "string", "maxLength": 128, "description": "Aliases: last_name." }, "receiver_phone": { "type": "string", "maxLength": 128, "description": "Aliases: phone." }, "receiver_state": { "type": "string", "maxLength": 4, "description": "Aliases: state, receiver_state_code." }, "receiver_tin": { "type": "string", "maxLength": 128, "description": "Aliases: receiver_inn." }, "receiver_zip_code": { "type": "string", "maxLength": 32, "description": "Aliases: zip_code." }, "redirect_fail_url": { "type": "string" }, "redirect_success_url": { "type": "string" }, "redirect_url": { "type": "string", "maxLength": 1024 }, "routing_number": { "type": "string", "maxLength": 32 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "site_url": { "type": "string", "maxLength": 100 }, "ssn": { "type": "string", "maxLength": 32 }, "tds_areq_notification_url": { "type": "string", "maxLength": 256, "minLength": 11, "description": "Aliases: tds_creq_notification_url, tds_cres_notification_url." }, "tds_authentication_result_authentication_type": { "type": "string", "maxLength": 2, "minLength": 2 }, "tds_authentication_result_authentication_value": { "type": "string", "maxLength": 28, "minLength": 19 }, "tds_authentication_result_message_version": { "type": "string", "maxLength": 5, "minLength": 5 }, "tds_authentication_result_transaction_id": { "type": "string", "maxLength": 36, "minLength": 19 }, "tds_authentication_result_transaction_status": { "type": "string", "maxLength": 1, "minLength": 1 }, "tds_authentication_result_type": { "type": "string", "maxLength": 6, "minLength": 6 }, "tds_challenge_window_size": { "type": "string", "maxLength": 11, "minLength": 2 }, "temporary_card_record_id": { "type": "string", "maxLength": 36 } }, "type": "object", "required": [ "amount", "client_orderid", "currency", "order_desc" ] }, "PayoutPayRequest": { "properties": { "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "login": { "type": "string" }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "orderid": { "type": "integer", "format": "int64" }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." } }, "type": "object", "required": [ "client_orderid", "login", "orderid" ] }, "PayoutRequest": { "properties": { "account_name": { "type": "string", "maxLength": 512 }, "account_number": { "type": "string", "maxLength": 64 }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_address1": { "type": "string", "maxLength": 256 }, "bank_area": { "type": "string", "maxLength": 128 }, "bank_bic": { "type": "string", "maxLength": 128 }, "bank_branch": { "type": "string", "maxLength": 512 }, "bank_city": { "type": "string", "maxLength": 128 }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_name": { "type": "string", "maxLength": 512 }, "bank_province": { "type": "string", "maxLength": 128 }, "bank_zip_code": { "type": "string", "maxLength": 32 }, "card_printed_name": { "type": "string", "maxLength": 128 }, "card_recurring_payment_id": { "type": "integer", "format": "int64" }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "credit_card_number": { "type": "string", "maxLength": 19, "pattern": "^\\d+$" }, "crypto_wallet_address": { "type": "string", "maxLength": 64 }, "currency": { "type": "string", "maxLength": 4 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "ewallet_type": { "type": "string", "maxLength": 64 }, "ewallet_wallet": { "type": "string", "maxLength": 128 }, "expire_month": { "type": "string", "maxLength": 2 }, "expire_year": { "type": "string", "maxLength": 4, "minLength": 2 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "legal_person_document_number": { "type": "string", "maxLength": 128 }, "legal_person_document_type": { "type": "string", "maxLength": 128 }, "legal_person_name": { "type": "string", "maxLength": 128 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "receiver_address1": { "type": "string", "maxLength": 256, "description": "Aliases: address1." }, "receiver_birthday": { "type": "string", "maxLength": 30, "description": "Aliases: birthday." }, "receiver_city": { "type": "string", "maxLength": 128, "description": "Aliases: city." }, "receiver_country_code": { "type": "string", "maxLength": 3, "description": "Aliases: country." }, "receiver_email": { "type": "string", "maxLength": 128, "description": "Aliases: email." }, "receiver_first_name": { "type": "string", "maxLength": 128, "description": "Aliases: first_name." }, "receiver_identity_document_id": { "type": "string", "maxLength": 128, "description": "Aliases: identity_document_id." }, "receiver_identity_document_number": { "type": "string", "maxLength": 16, "description": "Aliases: identity_document_number." }, "receiver_last_name": { "type": "string", "maxLength": 128, "description": "Aliases: last_name." }, "receiver_middle_name": { "type": "string", "maxLength": 128, "description": "Aliases: middle_name." }, "receiver_phone": { "type": "string", "maxLength": 128, "description": "Aliases: phone." }, "receiver_state": { "type": "string", "maxLength": 4, "description": "Aliases: state." }, "receiver_tin": { "type": "string", "maxLength": 128, "description": "Aliases: receiver_inn." }, "receiver_zip_code": { "type": "string", "maxLength": 32, "description": "Aliases: zip_code." }, "redirect_url": { "type": "string", "maxLength": 1024 }, "routing_number": { "type": "string", "maxLength": 32 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "temporary_card_record_id": { "type": "string", "maxLength": 36 } }, "type": "object", "required": [ "amount", "client_orderid", "currency" ] }, "PayoutV4Request": { "properties": { "account_name": { "type": "string", "maxLength": 512 }, "account_number": { "type": "string", "maxLength": 64 }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_address1": { "type": "string", "maxLength": 256 }, "bank_area": { "type": "string", "maxLength": 128 }, "bank_bic": { "type": "string", "maxLength": 128 }, "bank_branch": { "type": "string", "maxLength": 512 }, "bank_city": { "type": "string", "maxLength": 128 }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_name": { "type": "string", "maxLength": 512 }, "bank_province": { "type": "string", "maxLength": 128 }, "bank_zip_code": { "type": "string", "maxLength": 32 }, "card_printed_name": { "type": "string", "maxLength": 128 }, "card_recurring_payment_id": { "type": "integer", "format": "int64" }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "credit_card_number": { "type": "string", "maxLength": 19, "pattern": "^\\d+$" }, "crypto_wallet_address": { "type": "string", "maxLength": 64 }, "currency": { "type": "string", "maxLength": 4 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "ewallet_type": { "type": "string", "maxLength": 64 }, "ewallet_wallet": { "type": "string", "maxLength": 128 }, "expire_month": { "type": "string", "maxLength": 2 }, "expire_year": { "type": "string", "maxLength": 4, "minLength": 2 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "legal_person_document_number": { "type": "string", "maxLength": 128 }, "legal_person_document_type": { "type": "string", "maxLength": 128 }, "legal_person_name": { "type": "string", "maxLength": 128 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "receiver_address1": { "type": "string", "maxLength": 256, "description": "Aliases: address1." }, "receiver_birthday": { "type": "string", "maxLength": 30, "description": "Aliases: birthday." }, "receiver_city": { "type": "string", "maxLength": 128, "description": "Aliases: city." }, "receiver_country_code": { "type": "string", "maxLength": 3, "description": "Aliases: country." }, "receiver_email": { "type": "string", "maxLength": 128, "description": "Aliases: email." }, "receiver_first_name": { "type": "string", "maxLength": 128, "description": "Aliases: first_name." }, "receiver_identity_document_id": { "type": "string", "maxLength": 128, "description": "Aliases: identity_document_id." }, "receiver_identity_document_number": { "type": "string", "maxLength": 16, "description": "Aliases: identity_document_number." }, "receiver_last_name": { "type": "string", "maxLength": 128, "description": "Aliases: last_name." }, "receiver_middle_name": { "type": "string", "maxLength": 128, "description": "Aliases: middle_name." }, "receiver_phone": { "type": "string", "maxLength": 128, "description": "Aliases: phone." }, "receiver_state": { "type": "string", "maxLength": 4, "description": "Aliases: state." }, "receiver_tin": { "type": "string", "maxLength": 128, "description": "Aliases: receiver_inn." }, "receiver_zip_code": { "type": "string", "maxLength": 32, "description": "Aliases: zip_code." }, "redirect_url": { "type": "string", "maxLength": 1024 }, "routing_number": { "type": "string", "maxLength": 32 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "temporary_card_record_id": { "type": "string", "maxLength": 36 } }, "type": "object", "required": [ "amount", "client_orderid", "currency" ] }, "ProcessRecurringPaymentResponse": { "properties": { "serial-number": { "type": "string", "format": "uuid", "description": "Request serial number; echoed back from the request envelope." } }, "type": "object", "required": [ "serial-number" ] }, "RebillRequest": { "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "card_insurance_agreement_amount": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_bonus": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_end_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_number": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_sell_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_start_date": { "type": "string", "maxLength": 256 }, "cardrefid": { "type": "integer", "maximum": 10, "format": "int64" }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "control": { "type": "string", "description": "control \u003d SHA-1(login + client_orderid + cardrefid + amount + currency + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "field", "name": "login" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "cardrefid" }, { "source": "field", "name": "amount", "transform": "to-cents-integer" }, { "source": "field", "name": "currency" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "currency": { "type": "string", "maxLength": 4 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "cvv2": { "type": "string" }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "enumerate_amounts": { "type": "string" }, "insured_person_birthday": { "type": "string", "maxLength": 256 }, "insured_person_document_issue_date": { "type": "string", "maxLength": 256 }, "insured_person_document_issuer_code": { "type": "string", "maxLength": 32 }, "insured_person_document_issuer_name": { "type": "string", "maxLength": 256 }, "insured_person_document_number": { "type": "string", "maxLength": 256 }, "insured_person_document_series": { "type": "string", "maxLength": 256 }, "insured_person_email": { "type": "string", "maxLength": 256 }, "insured_person_first_name": { "type": "string", "maxLength": 256 }, "insured_person_last_name": { "type": "string", "maxLength": 256 }, "insured_person_middle_name": { "type": "string", "maxLength": 256 }, "insured_person_phone": { "type": "string", "maxLength": 256 }, "insured_person_registration_address": { "type": "string", "maxLength": 256 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 15 }, "login": { "type": "string" }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "recurrent_initiator": { "type": "string", "maxLength": 128 }, "recurrent_scenario": { "type": "string", "maxLength": 128 }, "redirect_url": { "type": "string", "maxLength": 1024 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "site_url": { "type": "string", "maxLength": 100 } }, "type": "object", "required": [ "amount", "cardrefid", "client_orderid", "control", "currency", "ipaddress", "login", "order_desc" ] }, "RecurringPaymentForCreation": { "properties": { "address1": { "type": "string", "maxLength": 256 }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amount_from": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Aliases: amount-from." }, "amount_sequence": { "type": "string", "maxLength": 255, "description": "Aliases: amount-sequence." }, "amount_to": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Aliases: amount-to." }, "birthday": { "type": "string", "description": "Date format: dd.MM.yyyy." }, "card_printed_name": { "type": "string", "maxLength": 128, "description": "Aliases: card-printed-name." }, "city": { "type": "string", "maxLength": 128 }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-orderid, client-order-id." }, "country": { "type": "string", "maxLength": 2, "minLength": 2 }, "credit_card_number": { "type": "string", "maxLength": 19, "minLength": 13, "pattern": "^\\d+$", "description": "Aliases: credit-card-number." }, "currency": { "type": "string", "maxLength": 3, "minLength": 3 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_ip": { "type": "string", "maxLength": 45, "minLength": 7, "description": "Aliases: customer-ip." }, "customer_level": { "type": "string", "maxLength": 32 }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "^\\d+$" }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "email": { "type": "string", "maxLength": 128 }, "expire_month": { "type": "integer", "maximum": 2, "minimum": 1, "format": "int32", "description": "Aliases: expire-month." }, "expire_year": { "type": "integer", "maximum": 4, "minimum": 4, "format": "int32", "description": "Aliases: expire-year." }, "finish_date": { "type": "string", "description": "Aliases: finish-date. Date format: dd.MM.yyyy." }, "first_name": { "type": "string", "maxLength": 128, "description": "Aliases: first-name." }, "interval": { "type": "integer", "format": "int32" }, "last_name": { "type": "string", "maxLength": 128, "description": "Aliases: last-name." }, "max_repeats_number": { "type": "integer", "format": "int32", "description": "Aliases: max-repeats-number." }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "notify_url": { "type": "string", "maxLength": 1024, "description": "Aliases: notify-url." }, "order_desc": { "type": "string", "maxLength": 65535, "description": "Aliases: payment-description." }, "period": { "type": "string", "maxLength": 32 }, "phone": { "type": "string", "maxLength": 128 }, "purpose": { "type": "string", "maxLength": 128 }, "rp_card_type": { "type": "string" }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "ssn": { "type": "string", "maxLength": 32 }, "start_date": { "type": "string", "description": "Aliases: start-date. Date format: dd.MM.yyyy." }, "state": { "type": "string", "maxLength": 3, "minLength": 2 }, "zip_code": { "type": "string", "maxLength": 10, "description": "Aliases: zip-code." } }, "type": "object", "required": [ "client_orderid", "rp_card_type" ] }, "RecurringPaymentForUpdate": { "properties": { "address1": { "type": "string", "maxLength": 256 }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amount_from": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Aliases: amount-from." }, "amount_sequence": { "type": "string", "maxLength": 255, "description": "Aliases: amount-sequence." }, "amount_to": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Aliases: amount-to." }, "birthday": { "type": "string", "description": "Date format: dd.MM.yyyy." }, "card_printed_name": { "type": "string", "maxLength": 128, "description": "Aliases: card-printed-name." }, "city": { "type": "string", "maxLength": 128 }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-orderid, client-order-id." }, "country": { "type": "string", "maxLength": 2, "minLength": 2 }, "credit_card_number": { "type": "string", "maxLength": 19, "minLength": 13, "pattern": "^\\d+$", "description": "Aliases: credit-card-number." }, "currency": { "type": "string", "maxLength": 3, "minLength": 3 }, "current_repeats_number": { "type": "integer", "format": "int32", "description": "Aliases: current-repeats-number." }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_ip": { "type": "string", "maxLength": 45, "minLength": 7, "description": "Aliases: customer-ip." }, "customer_level": { "type": "string", "maxLength": 32 }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "^\\d+$" }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "email": { "type": "string", "maxLength": 128 }, "expire_month": { "type": "integer", "maximum": 2, "minimum": 1, "format": "int32", "description": "Aliases: expire-month." }, "expire_year": { "type": "integer", "maximum": 4, "minimum": 4, "format": "int32", "description": "Aliases: expire-year." }, "finish_date": { "type": "string", "description": "Aliases: finish-date. Date format: dd.MM.yyyy." }, "first_name": { "type": "string", "maxLength": 128, "description": "Aliases: first-name." }, "interval": { "type": "integer", "format": "int32" }, "last_name": { "type": "string", "maxLength": 128, "description": "Aliases: last-name." }, "max_repeats_number": { "type": "integer", "format": "int32", "description": "Aliases: max-repeats-number." }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "notify_url": { "type": "string", "maxLength": 1024, "description": "Aliases: notify-url." }, "order_desc": { "type": "string", "maxLength": 65535, "description": "Aliases: payment-description." }, "period": { "type": "string", "maxLength": 32 }, "phone": { "type": "string", "maxLength": 128 }, "purpose": { "type": "string", "maxLength": 128 }, "recurring_payment_id": { "type": "integer", "format": "int64", "description": "Aliases: recurring-payment-id." }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "ssn": { "type": "string", "maxLength": 32 }, "start_date": { "type": "string", "description": "Aliases: start-date. Date format: dd.MM.yyyy." }, "state": { "type": "string", "maxLength": 3, "minLength": 2 }, "type": { "type": "string" }, "zip_code": { "type": "string", "maxLength": 10, "description": "Aliases: zip-code." } }, "type": "object", "required": [ "client_orderid", "recurring_payment_id" ] }, "RecurringPaymentToProcess": { "properties": { "address1": { "type": "string", "maxLength": 256 }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "birthday": { "type": "string", "description": "Date format: dd.MM.yyyy." }, "city": { "type": "string", "maxLength": 128 }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-orderid, client-order-id." }, "country": { "type": "string", "maxLength": 2, "minLength": 2 }, "currency": { "type": "string", "maxLength": 3, "minLength": 3 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_ip": { "type": "string", "maxLength": 45, "minLength": 7, "description": "Aliases: customer-ip." }, "customer_level": { "type": "string", "maxLength": 32 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "email": { "type": "string", "maxLength": 128 }, "first_name": { "type": "string", "maxLength": 128, "description": "Aliases: first-name." }, "last_name": { "type": "string", "maxLength": 128, "description": "Aliases: last-name." }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "notify_url": { "type": "string", "maxLength": 1024, "description": "Aliases: notify-url." }, "order_desc": { "type": "string", "maxLength": 65535, "description": "Aliases: payment-description." }, "phone": { "type": "string", "maxLength": 128 }, "purpose": { "type": "string", "maxLength": 128 }, "recurring_payment_id": { "type": "integer", "format": "int64", "description": "Aliases: recurring-payment-id." }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "ssn": { "type": "string", "maxLength": 32 }, "state": { "type": "string", "maxLength": 3, "minLength": 2 }, "zip_code": { "type": "string", "maxLength": 10, "description": "Aliases: zip-code." } }, "type": "object", "required": [ "amount", "client_orderid", "recurring_payment_id" ] }, "ReturnRequest": { "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "comment": { "type": "string" }, "control": { "type": "string", "description": "control \u003d SHA-1(login + client_orderid + orderid + amount + currency + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "field", "name": "login" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "orderid" }, { "source": "field", "name": "amount", "transform": "to-cents-integer" }, { "source": "field", "name": "currency" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "currency": { "type": "string" }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "login": { "type": "string" }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "orderid": { "type": "integer", "format": "int64" }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." } }, "type": "object", "required": [ "client_orderid", "comment", "control", "login", "orderid" ] }, "SaleFormRequest": { "properties": { "address1": { "type": "string", "maxLength": 256, "description": "Required if all of these are empty: card_recurring_payment_id." }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_phone": { "type": "string", "maxLength": 32 }, "birthday": { "type": "string", "maxLength": 30 }, "card_insurance_agreement_amount": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_bonus": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_end_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_number": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_sell_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_start_date": { "type": "string", "maxLength": 256 }, "card_printed_name": { "type": "string", "maxLength": 128 }, "card_recurring_payment_id": { "type": "integer", "format": "int64" }, "cardrefid": { "type": "integer", "maximum": 12, "format": "int64" }, "cell_phone": { "type": "string", "maxLength": 128 }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "city": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: card_recurring_payment_id." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "control": { "type": "string", "description": "control \u003d SHA-1(endpointId + client_orderid + amount + email + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "path", "name": "endpointId" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "amount", "transform": "to-cents-integer" }, { "source": "field", "name": "email" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "country": { "type": "string", "maxLength": 3, "description": "Required if all of these are empty: card_recurring_payment_id." }, "credit_card_number": { "type": "string", "pattern": "^\\d+$" }, "currency": { "type": "string", "maxLength": 4 }, "customer_accept": { "type": "string", "maxLength": 512, "description": "Aliases: customer_browser_accept_header." }, "customer_accept_language": { "type": "string", "maxLength": 128, "description": "Aliases: customer_browser_accept_language." }, "customer_browser_color_depth": { "type": "integer", "maximum": 2, "minimum": 1, "format": "int32" }, "customer_browser_info": { "type": "boolean" }, "customer_browser_java_enabled": { "type": "boolean" }, "customer_browser_javascript_enabled": { "type": "boolean" }, "customer_browser_screen_height": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_screen_width": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_time_zone": { "type": "integer", "maximum": 5, "minimum": 1, "format": "int32" }, "customer_csid": { "type": "string", "maxLength": 16384 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "customer_localtime": { "type": "string", "maxLength": 128 }, "customer_screen_size": { "type": "string", "maxLength": 32, "description": "Aliases: customer_screen." }, "customer_user_agent": { "type": "string", "maxLength": 512, "description": "Aliases: customer_agent, customer_browser_user_agent." }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "device_imei": { "type": "string", "maxLength": 32, "description": "Aliases: dapi_imei." }, "device_sn": { "type": "string", "maxLength": 64, "description": "Aliases: dapi_dsn." }, "driver_license": { "type": "string", "maxLength": 128 }, "email": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: card_recurring_payment_id." }, "expire_month": { "type": "string", "maxLength": 2 }, "expire_year": { "type": "string", "maxLength": 4, "minLength": 2 }, "first_name": { "type": "string", "maxLength": 128 }, "insurance_amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "insured_person_birthday": { "type": "string", "maxLength": 256 }, "insured_person_document_issue_date": { "type": "string", "maxLength": 256 }, "insured_person_document_issuer_code": { "type": "string", "maxLength": 32 }, "insured_person_document_issuer_name": { "type": "string", "maxLength": 256 }, "insured_person_document_number": { "type": "string", "maxLength": 256 }, "insured_person_document_series": { "type": "string", "maxLength": 256 }, "insured_person_email": { "type": "string", "maxLength": 256 }, "insured_person_first_name": { "type": "string", "maxLength": 256 }, "insured_person_last_name": { "type": "string", "maxLength": 256 }, "insured_person_middle_name": { "type": "string", "maxLength": 256 }, "insured_person_phone": { "type": "string", "maxLength": 256 }, "insured_person_registration_address": { "type": "string", "maxLength": 256 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "last_name": { "type": "string", "maxLength": 128 }, "maximum-transaction-amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "maxmind_phone_code": { "type": "string", "maxLength": 4 }, "maxmind_phone_id": { "type": "string", "maxLength": 128 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "merchant_form_data": { "type": "string", "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.MerchantFormDataValidator." }, "middle_name": { "type": "string", "maxLength": 128 }, "minimum-transaction-amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "payment_method": { "type": "string", "maxLength": 256 }, "phone": { "type": "string", "maxLength": 128 }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "redirect_fail_url": { "type": "string" }, "redirect_success_url": { "type": "string" }, "redirect_url": { "type": "string", "maxLength": 1024 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "site_url": { "type": "string", "maxLength": 100 }, "ssn": { "type": "string", "maxLength": 32 }, "state": { "type": "string", "maxLength": 32 }, "tds_areq_notification_url": { "type": "string", "maxLength": 256, "minLength": 11, "description": "Aliases: tds_creq_notification_url, tds_cres_notification_url." }, "tds_authentication_result_authentication_type": { "type": "string", "maxLength": 2, "minLength": 2 }, "tds_authentication_result_authentication_value": { "type": "string", "maxLength": 28, "minLength": 19 }, "tds_authentication_result_message_version": { "type": "string", "maxLength": 5, "minLength": 5 }, "tds_authentication_result_transaction_id": { "type": "string", "maxLength": 36, "minLength": 19 }, "tds_authentication_result_transaction_status": { "type": "string", "maxLength": 1, "minLength": 1 }, "tds_authentication_result_type": { "type": "string", "maxLength": 6, "minLength": 6 }, "tds_challenge_window_size": { "type": "string", "maxLength": 11, "minLength": 2 }, "temporary_card_record_id": { "type": "string", "maxLength": 36 }, "zip_code": { "type": "string", "maxLength": 32, "description": "Required if all of these are empty: card_recurring_payment_id." } }, "type": "object", "required": [ "amount", "client_orderid", "control", "currency", "ipaddress", "order_desc" ] }, "SaleRequest": { "properties": { "address1": { "type": "string", "maxLength": 256, "description": "Required if all of these are empty: card_recurring_payment_id." }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_phone": { "type": "string", "maxLength": 32 }, "birthday": { "type": "string", "maxLength": 30 }, "card_insurance_agreement_amount": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_bonus": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_end_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_number": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_sell_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_start_date": { "type": "string", "maxLength": 256 }, "card_printed_name": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: payment_method, card_recurring_payment_id." }, "card_recurring_payment_id": { "type": "integer", "format": "int64" }, "cell_phone": { "type": "string", "maxLength": 128 }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "city": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: card_recurring_payment_id." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "control": { "type": "string", "description": "control \u003d SHA-1(endpointId + client_orderid + amount + email + merchant_control_key). amount is in cents (e.g. 10.00 → 1000)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "path", "name": "endpointId" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "amount", "transform": "to-cents-integer" }, { "source": "field", "name": "email" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "country": { "type": "string", "maxLength": 3, "description": "Required if all of these are empty: card_recurring_payment_id." }, "credit_card_number": { "type": "string", "maxLength": 19, "pattern": "^\\d+$", "description": "Required if all of these are empty: temporary_card_record_id, card_recurring_payment_id, payment_method." }, "currency": { "type": "string", "maxLength": 4 }, "customer_accept": { "type": "string", "maxLength": 512, "description": "Aliases: customer_browser_accept_header." }, "customer_accept_language": { "type": "string", "maxLength": 128, "description": "Aliases: customer_browser_accept_language." }, "customer_browser_color_depth": { "type": "integer", "maximum": 2, "minimum": 1, "format": "int32" }, "customer_browser_info": { "type": "boolean" }, "customer_browser_java_enabled": { "type": "boolean" }, "customer_browser_javascript_enabled": { "type": "boolean" }, "customer_browser_screen_height": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_screen_width": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_time_zone": { "type": "integer", "maximum": 5, "minimum": 1, "format": "int32" }, "customer_csid": { "type": "string", "maxLength": 16384 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "customer_localtime": { "type": "string", "maxLength": 128 }, "customer_screen_size": { "type": "string", "maxLength": 32, "description": "Aliases: customer_screen." }, "customer_user_agent": { "type": "string", "maxLength": 512, "description": "Aliases: customer_agent, customer_browser_user_agent." }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "device_imei": { "type": "string", "maxLength": 32, "description": "Aliases: dapi_imei." }, "device_sn": { "type": "string", "maxLength": 64, "description": "Aliases: dapi_dsn." }, "driver_license": { "type": "string", "maxLength": 128 }, "email": { "type": "string", "maxLength": 128, "description": "Required if all of these are empty: card_recurring_payment_id." }, "expire_month": { "type": "string", "maxLength": 2, "description": "Required if all of these are empty: payment_method, card_recurring_payment_id." }, "expire_year": { "type": "string", "maxLength": 4, "minLength": 2, "description": "Required if all of these are empty: payment_method, card_recurring_payment_id." }, "first_name": { "type": "string", "maxLength": 128 }, "insurance_amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "insured_person_birthday": { "type": "string", "maxLength": 256 }, "insured_person_document_issue_date": { "type": "string", "maxLength": 256 }, "insured_person_document_issuer_code": { "type": "string", "maxLength": 32 }, "insured_person_document_issuer_name": { "type": "string", "maxLength": 256 }, "insured_person_document_number": { "type": "string", "maxLength": 256 }, "insured_person_document_series": { "type": "string", "maxLength": 256 }, "insured_person_email": { "type": "string", "maxLength": 256 }, "insured_person_first_name": { "type": "string", "maxLength": 256 }, "insured_person_last_name": { "type": "string", "maxLength": 256 }, "insured_person_middle_name": { "type": "string", "maxLength": 256 }, "insured_person_phone": { "type": "string", "maxLength": 256 }, "insured_person_registration_address": { "type": "string", "maxLength": 256 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "last_name": { "type": "string", "maxLength": 128 }, "maxmind_phone_code": { "type": "string", "maxLength": 4 }, "maxmind_phone_id": { "type": "string", "maxLength": 128 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "middle_name": { "type": "string", "maxLength": 128 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "payment_method": { "type": "string", "maxLength": 256 }, "phone": { "type": "string", "maxLength": 128 }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "redirect_fail_url": { "type": "string" }, "redirect_success_url": { "type": "string" }, "redirect_url": { "type": "string", "maxLength": 1024 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "site_url": { "type": "string", "maxLength": 100 }, "ssn": { "type": "string", "maxLength": 32 }, "state": { "type": "string", "maxLength": 32 }, "tds_areq_notification_url": { "type": "string", "maxLength": 256, "minLength": 11, "description": "Aliases: tds_creq_notification_url, tds_cres_notification_url." }, "tds_authentication_result_authentication_type": { "type": "string", "maxLength": 2, "minLength": 2 }, "tds_authentication_result_authentication_value": { "type": "string", "maxLength": 28, "minLength": 19 }, "tds_authentication_result_message_version": { "type": "string", "maxLength": 5, "minLength": 5 }, "tds_authentication_result_transaction_id": { "type": "string", "maxLength": 36, "minLength": 19 }, "tds_authentication_result_transaction_status": { "type": "string", "maxLength": 1, "minLength": 1 }, "tds_authentication_result_type": { "type": "string", "maxLength": 6, "minLength": 6 }, "tds_challenge_window_size": { "type": "string", "maxLength": 11, "minLength": 2 }, "temporary_card_record_id": { "type": "string", "maxLength": 36 }, "zip_code": { "type": "string", "maxLength": 32, "description": "Required if all of these are empty: card_recurring_payment_id." } }, "type": "object", "required": [ "amount", "client_orderid", "control", "currency", "ipaddress", "order_desc" ] }, "ServerErrorResponse": { "properties": { "error-code": { "type": "integer", "format": "int32", "description": "Code from com.payneteasy.paynet.processing.ResponseError enum." }, "error-message": { "type": "string" }, "merchant-order-id": { "type": "string" }, "serial-number": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "error" ] } }, "type": "object", "required": [ "error-code", "error-message", "serial-number", "type" ], "description": "Response returned when the service fails to handle the request due to an internal error." }, "StatusRequest": { "properties": { "by-request-sn": { "type": "string", "maxLength": 40, "format": "uuid" }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "control": { "type": "string", "description": "control \u003d SHA-1(login + client_orderid + orderid + merchant_control_key)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "field", "name": "login" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "orderid", "transform": "empty-if-null" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "login": { "type": "string" }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "orderid": { "type": "integer", "format": "int64" }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." } }, "type": "object", "required": [ "client_orderid", "control", "login" ] }, "StatusResponse": { "properties": { "account-number": { "type": "string" }, "acquirer-commission": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "acquirer-processing-date": { "type": "string", "format": "date-time" }, "address1": { "type": "string" }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "approval-code": { "type": "string" }, "auth-response-code": { "type": "string" }, "auxiliary-sessions": { "type": "string" }, "avs-response-code": { "type": "string" }, "bank-name": { "type": "string" }, "bin": { "type": "string" }, "business-lounge-product-brand-name": { "type": "string" }, "business-lounge-response": { "type": "string" }, "by-request-sn": { "type": "string", "format": "uuid" }, "card-country-alpha-three-code": { "type": "string" }, "card-exp-month": { "type": "integer", "format": "int32" }, "card-exp-year": { "type": "integer", "format": "int32" }, "card-hash-id": { "type": "integer", "format": "int64" }, "card-ref-id": { "type": "integer", "format": "int64" }, "card-type": { "type": "string" }, "cardholder-name": { "type": "string" }, "city": { "type": "string" }, "comment": { "type": "string" }, "country": { "type": "string" }, "currency": { "type": "string" }, "customer-id": { "type": "integer", "format": "int64" }, "customer-ip": { "type": "string" }, "customer-level": { "type": "string" }, "customer-wants-to-register-card": { "type": "boolean" }, "descriptor": { "type": "string" }, "dest-bank-name": { "type": "string" }, "dest-bin": { "type": "string" }, "dest-card-type": { "type": "string" }, "dest-last-four-digits": { "type": "string" }, "destination-card-country-alpha-three-code": { "type": "string" }, "destination-card-hash-id": { "type": "integer", "format": "int64" }, "dst-recurring-payment-id": { "type": "integer", "format": "int64" }, "eci": { "type": "string" }, "effective-exchange-rate": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "email": { "type": "string" }, "emv-app-cryptogram-9f26": { "type": "string", "format": "byte" }, "emv-app-label-50": { "type": "string" }, "emv-cid-9f27": { "type": "string", "format": "byte" }, "emv-cvr-9f34": { "type": "string", "format": "byte" }, "emv-issuer-response": { "type": "string" }, "emv-pan-sequence-5f34": { "type": "integer", "maximum": 127, "minimum": -128, "format": "int32" }, "emv-terminal-aid-9f06": { "type": "string", "format": "byte" }, "emv-tvr-95": { "type": "string", "format": "byte" }, "error-code": { "type": "integer", "format": "int32" }, "error-group": { "type": "integer", "format": "int32" }, "error-message": { "type": "string" }, "event": { "type": "string" }, "exchange-rate": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "exchanged-amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "exchanged-to-currency": { "type": "string" }, "external-payment-method": { "type": "string" }, "first-name": { "type": "string" }, "gate-method2": { "type": "string" }, "gate-partial-capture": { "type": "boolean" }, "gate-partial-reversal": { "type": "boolean" }, "html": { "type": "string" }, "initial-amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "ips-dst-payment-product-code": { "type": "string" }, "ips-dst-payment-product-name": { "type": "string" }, "ips-dst-payment-type-code": { "type": "string" }, "ips-dst-payment-type-name": { "type": "string" }, "ips-src-payment-product-code": { "type": "string" }, "ips-src-payment-product-name": { "type": "string" }, "ips-src-payment-type-code": { "type": "string" }, "ips-src-payment-type-name": { "type": "string" }, "isignthis-transaction-id": { "type": "string" }, "last-four-digits": { "type": "string" }, "last-name": { "type": "string" }, "loyalty-balance": { "type": "string" }, "loyalty-bonus": { "type": "string" }, "loyalty-message": { "type": "string" }, "loyalty-program": { "type": "string" }, "merchant-customer-identifier": { "type": "string" }, "merchant-order-id": { "type": "string" }, "merchantdata": { "type": "string" }, "motivational-message": { "type": "string" }, "need-verification": { "type": "boolean" }, "order-stage": { "type": "string" }, "original-gate-descriptor": { "type": "string" }, "otp-status": { "type": "string" }, "paynet-order-id": { "type": "integer", "format": "int64" }, "paynet-processing-date": { "type": "string", "format": "date-time" }, "phone": { "type": "string" }, "poli-bank-receipt": { "type": "string" }, "poli-id": { "type": "string" }, "processor-auth-credit-code": { "type": "string" }, "processor-credit-arn": { "type": "string" }, "processor-credit-rrn": { "type": "string" }, "processor-debit-arn": { "type": "string" }, "processor-drn": { "type": "string" }, "processor-rrn": { "type": "string" }, "processor-side-selected-bank-code": { "type": "string" }, "processor-token": { "type": "string" }, "processor-tx-id": { "type": "string" }, "purpose": { "type": "string" }, "qr-code": { "type": "string" }, "qr-code-payload-type": { "type": "string", "enum": [ "SBP", "UNKNOWN", "UPI" ] }, "qr-code-payload-value": { "type": "string" }, "rapida-balance": { "type": "string" }, "reader-entry-type": { "type": "string", "enum": [ "MAGNETIC_STRIPE_SIGNATURE", "EMV_CONTACT_PIN_OFFLINE", "EMV_CONTACT_PIN_OFFLINE_AND_SIGNATURE", "EMV_CONTACT_PIN_ONLINE", "EMV_CONTACT_SIGNATURE", "EMV_CONTACTLESS_SIGNATURE", "EMV_CONTACTLESS_SIGNATURE_MAGSTRIPE", "EMV_CONTACTLESS_PIN_ONLINE", "MOTO" ] }, "reader-processing-date": { "type": "string", "format": "date-time" }, "reason-code": { "type": "string" }, "receipt-id": { "type": "string" }, "receiver-addr": { "type": "string" }, "receiver-name": { "type": "string" }, "recurring-payment-id": { "type": "integer", "format": "int64" }, "redirect-data": { "type": "string" }, "redirect-to": { "type": "string" }, "reversal-amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "seller-commission": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "serial-number": { "type": "string", "format": "uuid", "description": "Request serial number; echoed back from the request envelope." }, "state": { "type": "string" }, "status": { "type": "string", "enum": [ "APPROVED", "DECLINED", "FILTERED", "PROCESSING", "ERROR", "UNKNOWN", "CHAIN_DECLINED" ] }, "tds-creq-form-acs-url": { "type": "string" }, "tds-creq-form-creq": { "type": "string" }, "tds-method-form": { "type": "string" }, "tds-method-form-csp": { "type": "string" }, "tds-method-url-frame-3ds-method-url": { "type": "string" }, "tds-method-url-frame-3ds-server-trans-id": { "type": "string" }, "tds-pareq-form-acs-url": { "type": "string" }, "tds-pareq-form-md": { "type": "string" }, "tds-pareq-form-pareq": { "type": "string" }, "tds-pareq-form-term-url": { "type": "string" }, "tds-status": { "type": "string", "enum": [ "PaReqForm", "PaResProcessing", "MethodUrlFrame", "MethodUrlProcessing", "CReqForm", "CResProcessing" ] }, "terminal-id": { "type": "string" }, "total-reversal-amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "transaction-date": { "type": "string", "format": "date-time" }, "transaction-type": { "type": "string" }, "verified-3d-status": { "type": "string" }, "verified-rsc-status": { "type": "string" }, "zip_code": { "type": "string" } }, "type": "object", "required": [ "serial-number" ] }, "StatusV4Request": { "properties": { "by-request-sn": { "type": "string", "maxLength": 40, "format": "uuid" }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "login": { "type": "string" }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "orderid": { "type": "integer", "format": "int64" }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." } }, "type": "object", "required": [ "client_orderid", "login" ] }, "TdsCResResultRequest": { "properties": { "client-order-id": { "type": "string", "maxLength": 128, "description": "Aliases: client_orderid." }, "control": { "type": "string", "description": "control \u003d SHA-1(login + client-order-id + orderid + merchant_control_key)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "field", "name": "login" }, { "source": "field", "name": "client-order-id" }, { "source": "field", "name": "orderid" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "cres": { "type": "string", "maxLength": 2097152, "description": "Aliases: cRes, c-res." }, "login": { "type": "string" }, "orderid": { "type": "integer", "maximum": 40, "format": "int64", "description": "Aliases: orderId, order-id." } }, "type": "object", "required": [ "client-order-id", "control", "cres", "login", "orderid" ] }, "TdsMethodUrlResultRequest": { "properties": { "browserAcceptHeader": { "type": "string", "maxLength": 2048 }, "browserColorDepth": { "type": "integer", "maximum": 2, "format": "int32" }, "browserIP": { "type": "string", "maxLength": 45 }, "browserJavaEnabled": { "type": "boolean" }, "browserJavascriptEnabled": { "type": "boolean" }, "browserLanguage": { "type": "string", "maxLength": 8 }, "browserScreenHeight": { "type": "integer", "maximum": 6, "format": "int32" }, "browserScreenWidth": { "type": "integer", "maximum": 6, "format": "int32" }, "browserTZ": { "type": "integer", "maximum": 5, "format": "int32" }, "browserTimeZoneName": { "type": "string" }, "browserUserAgent": { "type": "string", "maxLength": 2048 }, "challengeWindowSize": { "type": "string", "maxLength": 11, "minLength": 2 }, "client-order-id": { "type": "string", "maxLength": 128, "description": "Aliases: client_orderid." }, "control": { "type": "string", "description": "control \u003d SHA-1(login + client-order-id + orderid + merchant_control_key)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "field", "name": "login" }, { "source": "field", "name": "client-order-id" }, { "source": "field", "name": "orderid" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "login": { "type": "string" }, "notificationURL": { "type": "string", "maxLength": 256 }, "orderid": { "type": "integer", "maximum": 40, "format": "int64", "description": "Aliases: orderId, order-id." }, "threeDSCompInd": { "type": "string", "maxLength": 1 }, "threeDSServerTransID": { "type": "string", "maxLength": 36 } }, "type": "object", "required": [ "browserAcceptHeader", "browserColorDepth", "browserIP", "browserJavaEnabled", "browserJavascriptEnabled", "browserLanguage", "browserScreenHeight", "browserScreenWidth", "browserTZ", "browserUserAgent", "client-order-id", "control", "login", "notificationURL", "orderid", "threeDSCompInd", "threeDSServerTransID" ] }, "TdsPaResResultRequest": { "properties": { "client-order-id": { "type": "string", "maxLength": 128, "description": "Aliases: client_orderid." }, "control": { "type": "string", "description": "control \u003d SHA-1(login + client-order-id + orderid + merchant_control_key)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "field", "name": "login" }, { "source": "field", "name": "client-order-id" }, { "source": "field", "name": "orderid" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "login": { "type": "string" }, "md": { "type": "string", "maxLength": 1024, "description": "Aliases: MD." }, "orderid": { "type": "integer", "maximum": 40, "format": "int64", "description": "Aliases: orderId, order-id." }, "paRes": { "type": "string", "maxLength": 10000, "description": "Aliases: pares, pa-res." } }, "type": "object", "required": [ "client-order-id", "control", "login", "orderid", "paRes" ] }, "TransferByRefV4Request": { "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "card_insurance_agreement_amount": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_bonus": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_end_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_number": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_sell_date": { "type": "string", "maxLength": 256 }, "card_insurance_agreement_start_date": { "type": "string", "maxLength": 256 }, "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "currency": { "type": "string", "maxLength": 4 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "cvv2": { "type": "string" }, "destination-card-no": { "type": "string", "maxLength": 128, "pattern": "^\\d+$" }, "destination-card-ref-id": { "type": "integer", "maximum": 10, "format": "int64" }, "destination_card_printed_name": { "type": "string", "maxLength": 128 }, "destination_expire_month": { "type": "string", "maxLength": 2 }, "destination_expire_year": { "type": "string", "maxLength": 4, "minLength": 2 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "insurance_amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "insured_person_birthday": { "type": "string", "maxLength": 256 }, "insured_person_document_issue_date": { "type": "string", "maxLength": 256 }, "insured_person_document_issuer_code": { "type": "string", "maxLength": 32 }, "insured_person_document_issuer_name": { "type": "string", "maxLength": 256 }, "insured_person_document_number": { "type": "string", "maxLength": 256 }, "insured_person_document_series": { "type": "string", "maxLength": 256 }, "insured_person_email": { "type": "string", "maxLength": 256 }, "insured_person_first_name": { "type": "string", "maxLength": 256 }, "insured_person_last_name": { "type": "string", "maxLength": 256 }, "insured_person_middle_name": { "type": "string", "maxLength": 256 }, "insured_person_phone": { "type": "string", "maxLength": 256 }, "insured_person_registration_address": { "type": "string", "maxLength": 256 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 15 }, "login": { "type": "string" }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128, "description": "Aliases: destination." }, "receiver_address1": { "type": "string", "maxLength": 128 }, "receiver_area": { "type": "string", "maxLength": 50 }, "receiver_birth_place": { "type": "string", "maxLength": 128 }, "receiver_birthday": { "type": "string", "maxLength": 30 }, "receiver_citizenship": { "type": "string", "maxLength": 128 }, "receiver_city": { "type": "string", "maxLength": 128 }, "receiver_country_code": { "type": "string", "maxLength": 3 }, "receiver_email": { "type": "string", "maxLength": 128 }, "receiver_first_name": { "type": "string", "maxLength": 128 }, "receiver_identity_document_id": { "type": "string", "maxLength": 128 }, "receiver_identity_document_issue_date": { "type": "string", "maxLength": 128, "format": "date-time" }, "receiver_identity_document_issuer_department_code": { "type": "string", "maxLength": 128 }, "receiver_identity_document_issuer_name": { "type": "string", "maxLength": 128 }, "receiver_identity_document_number": { "type": "string", "maxLength": 128 }, "receiver_identity_document_series": { "type": "string", "maxLength": 128 }, "receiver_last_name": { "type": "string", "maxLength": 128 }, "receiver_middle_name": { "type": "string", "maxLength": 128 }, "receiver_phone": { "type": "string", "maxLength": 128 }, "receiver_region": { "type": "string", "maxLength": 30 }, "receiver_resident": { "type": "boolean" }, "receiver_state_code": { "type": "string", "maxLength": 3 }, "receiver_zip_code": { "type": "string", "maxLength": 128 }, "redirect_url": { "type": "string", "maxLength": 1024 }, "sender-ssn": { "type": "string", "maxLength": 32, "description": "Aliases: ssn." }, "sender_address1": { "type": "string", "maxLength": 128, "description": "Aliases: address1." }, "sender_birth_place": { "type": "string", "maxLength": 128 }, "sender_birthday": { "type": "string", "maxLength": 30, "description": "Aliases: birthday." }, "sender_cell_phone": { "type": "string", "maxLength": 128, "description": "Aliases: cell_phone." }, "sender_citizenship": { "type": "string", "maxLength": 128 }, "sender_city": { "type": "string", "maxLength": 128, "description": "Aliases: city." }, "sender_country_code": { "type": "string", "maxLength": 3, "description": "Aliases: country." }, "sender_email": { "type": "string", "maxLength": 128, "description": "Aliases: email." }, "sender_first_name": { "type": "string", "maxLength": 128, "description": "Aliases: first_name." }, "sender_identity_document_id": { "type": "string", "maxLength": 128 }, "sender_identity_document_issue_date": { "type": "string", "format": "date-time" }, "sender_identity_document_issuer_department_code": { "type": "string", "maxLength": 32 }, "sender_identity_document_issuer_name": { "type": "string", "maxLength": 128 }, "sender_identity_document_number": { "type": "string", "maxLength": 16 }, "sender_identity_document_series": { "type": "string", "maxLength": 12 }, "sender_last_name": { "type": "string", "maxLength": 128, "description": "Aliases: last_name." }, "sender_middle_name": { "type": "string", "maxLength": 128, "description": "Aliases: middle_name." }, "sender_phone": { "type": "string", "maxLength": 128, "description": "Aliases: phone." }, "sender_resident": { "type": "boolean" }, "sender_state": { "type": "string", "maxLength": 4, "description": "Aliases: state." }, "sender_zip_code": { "type": "string", "maxLength": 32, "description": "Aliases: zip_code." }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "source-card-ref-id-turn-off-34ecc8f3-89f4-48fd-83dd-ba6b18ac3c09": { "type": "integer", "maximum": 10, "format": "int64" } }, "type": "object", "required": [ "amount", "client_orderid", "currency" ] }, "TransferV4Request": { "properties": { "address1": { "type": "string", "maxLength": 256 }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bank_code": { "type": "string", "maxLength": 32 }, "bank_phone": { "type": "string", "maxLength": 32 }, "card_printed_name": { "type": "string", "maxLength": 128 }, "card_recurring_payment_id": { "type": "integer", "maximum": 36, "format": "int64" }, "cheque": { "type": "string", "maxLength": 2048, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "city": { "type": "string", "maxLength": 128 }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "country": { "type": "string", "maxLength": 3 }, "credit_card_number": { "type": "string", "maxLength": 19, "pattern": "^\\d+$" }, "currency": { "type": "string", "maxLength": 3 }, "customer_accept": { "type": "string", "maxLength": 512, "description": "Aliases: customer_browser_accept_header." }, "customer_accept_language": { "type": "string", "maxLength": 128, "description": "Aliases: customer_browser_accept_language." }, "customer_browser_color_depth": { "type": "integer", "maximum": 2, "minimum": 1, "format": "int32" }, "customer_browser_info": { "type": "boolean" }, "customer_browser_java_enabled": { "type": "boolean" }, "customer_browser_javascript_enabled": { "type": "boolean" }, "customer_browser_screen_height": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_screen_width": { "type": "integer", "maximum": 6, "minimum": 1, "format": "int32" }, "customer_browser_time_zone": { "type": "integer", "maximum": 5, "minimum": 1, "format": "int32" }, "customer_csid": { "type": "string", "maxLength": 16384 }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "customer_localtime": { "type": "string", "maxLength": 128 }, "customer_screen_size": { "type": "string", "maxLength": 32, "description": "Aliases: customer_screen." }, "customer_user_agent": { "type": "string", "maxLength": 512, "description": "Aliases: customer_agent, customer_browser_user_agent." }, "cvv2": { "type": "string", "maxLength": 4, "minLength": 3 }, "deposit2card": { "type": "boolean" }, "destination-card-no": { "type": "string", "maxLength": 19, "pattern": "^\\d+$", "description": "Aliases: destination." }, "destination_card_printed_name": { "type": "string", "maxLength": 128 }, "destination_card_recurring_payment_id": { "type": "integer", "maximum": 36, "format": "int64" }, "destination_expire_month": { "type": "string", "maxLength": 2 }, "destination_expire_year": { "type": "string", "maxLength": 4, "minLength": 2 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "email": { "type": "string", "maxLength": 128 }, "expire_month": { "type": "string", "maxLength": 2 }, "expire_year": { "type": "string", "maxLength": 4, "minLength": 2 }, "ipaddress": { "type": "string", "maxLength": 45, "minLength": 7 }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "merchant_data": { "type": "string" }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "order_desc": { "type": "string" }, "phone": { "type": "string", "maxLength": 128 }, "preferred_language": { "type": "string", "maxLength": 2 }, "purpose": { "type": "string", "maxLength": 128 }, "receiver_address1": { "type": "string", "maxLength": 128 }, "receiver_area": { "type": "string", "maxLength": 50 }, "receiver_birthday": { "type": "string", "maxLength": 30 }, "receiver_birthplace": { "type": "string", "maxLength": 128, "description": "Aliases: receiver_birth_place." }, "receiver_citizenship": { "type": "string", "maxLength": 128 }, "receiver_city": { "type": "string", "maxLength": 128 }, "receiver_country_code": { "type": "string", "maxLength": 3 }, "receiver_email": { "type": "string", "maxLength": 128 }, "receiver_first_name": { "type": "string", "maxLength": 128 }, "receiver_identity_document_id": { "type": "string", "maxLength": 128 }, "receiver_identity_document_issue_date": { "type": "string", "maxLength": 128, "format": "date-time" }, "receiver_identity_document_issuer_department_code": { "type": "string", "maxLength": 128 }, "receiver_identity_document_issuer_name": { "type": "string", "maxLength": 128 }, "receiver_identity_document_number": { "type": "string", "maxLength": 128 }, "receiver_identity_document_series": { "type": "string", "maxLength": 128 }, "receiver_last_name": { "type": "string", "maxLength": 128 }, "receiver_middle_name": { "type": "string", "maxLength": 128 }, "receiver_phone": { "type": "string", "maxLength": 128 }, "receiver_region": { "type": "string", "maxLength": 30 }, "receiver_resident": { "type": "boolean" }, "receiver_state_code": { "type": "string", "maxLength": 4, "description": "Aliases: receiver_state." }, "receiver_zip_code": { "type": "string", "maxLength": 128 }, "redirect_fail_url": { "type": "string", "maxLength": 1024 }, "redirect_success_url": { "type": "string", "maxLength": 1024 }, "redirect_url": { "type": "string", "maxLength": 1024 }, "sender_address1": { "type": "string", "maxLength": 256 }, "sender_birthday": { "type": "string", "maxLength": 30 }, "sender_birthplace": { "type": "string", "maxLength": 128, "description": "Aliases: sender_birth_place." }, "sender_cell_phone": { "type": "string", "maxLength": 128 }, "sender_citizenship": { "type": "string", "maxLength": 128 }, "sender_city": { "type": "string", "maxLength": 128 }, "sender_country_code": { "type": "string", "maxLength": 3 }, "sender_email": { "type": "string", "maxLength": 128 }, "sender_first_name": { "type": "string", "maxLength": 128 }, "sender_identity_document_id": { "type": "string", "maxLength": 128 }, "sender_identity_document_issue_date": { "type": "string", "maxLength": 128, "format": "date-time" }, "sender_identity_document_issuer_department_code": { "type": "string", "maxLength": 32 }, "sender_identity_document_issuer_name": { "type": "string", "maxLength": 128 }, "sender_identity_document_number": { "type": "string", "maxLength": 16 }, "sender_identity_document_series": { "type": "string", "maxLength": 12 }, "sender_last_name": { "type": "string", "maxLength": 128 }, "sender_middle_name": { "type": "string", "maxLength": 128 }, "sender_phone": { "type": "string", "maxLength": 128 }, "sender_resident": { "type": "boolean" }, "sender_ssn": { "type": "string", "maxLength": 32 }, "sender_state": { "type": "string", "maxLength": 4 }, "sender_zip_code": { "type": "string", "maxLength": 32 }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." }, "site_url": { "type": "string", "maxLength": 100 }, "state": { "type": "string", "maxLength": 4 }, "tds_areq_notification_url": { "type": "string", "maxLength": 256, "minLength": 11, "description": "Aliases: tds_creq_notification_url, tds_cres_notification_url." }, "tds_authentication_result_authentication_type": { "type": "string", "maxLength": 2, "minLength": 2, "pattern": "^\\d+$" }, "tds_authentication_result_authentication_value": { "type": "string", "maxLength": 28, "minLength": 19 }, "tds_authentication_result_message_version": { "type": "string", "maxLength": 5, "minLength": 5 }, "tds_authentication_result_transaction_id": { "type": "string", "maxLength": 36, "minLength": 19 }, "tds_authentication_result_transaction_status": { "type": "string", "maxLength": 1, "minLength": 1 }, "tds_authentication_result_type": { "type": "string", "maxLength": 6, "minLength": 6 }, "tds_challenge_window_size": { "type": "string", "maxLength": 11, "minLength": 2 }, "zip_code": { "type": "string", "maxLength": 32 } }, "type": "object", "required": [ "amount", "client_orderid", "currency", "ipaddress", "order_desc" ] }, "UpdateRecurringPaymentResponse": { "properties": { "serial-number": { "type": "string", "format": "uuid", "description": "Request serial number; echoed back from the request envelope." } }, "type": "object", "required": [ "serial-number" ] }, "ValidationErrorResponse": { "properties": { "error-code": { "type": "integer", "format": "int32", "description": "Code from com.payneteasy.paynet.processing.ResponseError enum." }, "error-message": { "type": "string" }, "merchant-order-id": { "type": "string" }, "serial-number": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "validation-error" ] } }, "type": "object", "required": [ "error-code", "error-message", "serial-number", "type" ], "description": "Response returned when the incoming request fails validation." }, "VoidRequest": { "properties": { "cheque": { "type": "string", "maxLength": 16384, "description": "Custom validator: com.payneteasy.paynet.processing.support.validation.validators.OnlineChequeValidator." }, "client_orderid": { "type": "string", "maxLength": 128, "description": "Aliases: client-order-id." }, "comment": { "type": "string" }, "control": { "type": "string", "description": "control \u003d SHA-1(login + client_orderid + orderid + merchant_control_key)", "x-control-hash": { "algorithm": "SHA-1", "encoding": "hex-lowercase", "parts": [ { "source": "field", "name": "login" }, { "source": "field", "name": "client_orderid" }, { "source": "field", "name": "orderid" }, { "source": "secret", "name": "merchant_control_key" } ] } }, "customer_id": { "type": "integer", "maximum": 10, "format": "int64" }, "customer_level": { "type": "string", "maxLength": 32 }, "developer_identity": { "type": "string", "maxLength": 256, "description": "Aliases: developer-identity." }, "login": { "type": "string" }, "merchant_customer_identifier": { "type": "string", "maxLength": 64 }, "notify_url": { "type": "string", "description": "Aliases: notify-url." }, "orderid": { "type": "integer", "format": "int64" }, "server_callback_url": { "type": "string", "maxLength": 1024, "description": "Aliases: server-callback-url." } }, "type": "object", "required": [ "client_orderid", "comment", "control", "login", "orderid" ] } } } }