--- $schema: "https://developers.ecommpay.com/schemas/frontmatter.json" schema_version: "1.0" content: id: "gate_api" type: "specification" title: "Gate API" description: "The Gate API specification with the descriptions of data structures and schemas for generating requests to different endpoints." language: "en" format: "openapi" openapi_version: "3.0.2" api_version: "3.38.1" status: "current" date_modified: "2026-10-15T13:13:19Z" hash: "sha256:9f3c89dfd378efc7352ee8ad789119dfb5f7b1bef9a26218910692ae43078d4f" urls: canonical: "https://api-developers.ecommpay.com" markdown: "https://developers.ecommpay.com/en/gate_api.md" navigation: parent: "https://developers.ecommpay.com/en/index.md" index: "https://developers.ecommpay.com/en/index.md" in_corpus: true ai_context: "A machine-readable API specification in Markdown format, derived from the OpenAPI source. It is designed to understand request/response schemas, endpoints, and data types." --- # Gate API {#gate_api} **Up one level:** [Gate](en_Gate_Integration_About.md) { "openapi": "3.0.2", "info": { "title": "Gate API", "description": "Ecommpay Gate public API is an interface for merchants to perform operations and retrieve operation information", "version": "3.38.1" }, "servers": [ { "url": "https://api.ecommpay.com" } ], "paths": { "/v2/payment/card/sale": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/sale", "description": "Request for purchase from the customer's card", "operationId": "POST_v2-payment-card-sale", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "card", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "card": { "$ref": "#/components/schemas/CardInfoForSaleAuth" }, "token_data": { "$ref": "#/components/schemas/TokenData" }, "customer": { "allOf": [ { "$ref": "#/components/schemas/CustomerInfoCard" }, { "type": "object", "properties": {}, "required": [ "email", "phone", "screen_res" ] } ] }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "avs_data": { "$ref": "#/components/schemas/AvsInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfoForCard" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "recurring_register": { "description": "Indicator that defines whether the payment should be registered as credential-on-file. Is assigned to the true value to register credential-on-file payment", "type": "boolean" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "sender": { "$ref": "#/components/schemas/SenderInfoSale" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "addendum": { "$ref": "#/components/schemas/AddendumInitialCard" }, "acs_return_url": { "$ref": "#/components/schemas/ACSReturnUrl" }, "authentication_data": { "$ref": "#/components/schemas/AuthenticationData" }, "recipient": { "$ref": "#/components/schemas/RecipientForCard" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "installment": { "$ref": "#/components/schemas/Installment" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/sale/saved": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/sale/saved", "description": "Request for purchase from the customer's saved card", "operationId": "POST_v2-payment-card-sale-saved", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "saved_account_id" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "allOf": [ { "$ref": "#/components/schemas/CustomerInfoCard" }, { "type": "object", "properties": {}, "required": [ "email", "phone", "screen_res" ] } ] }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfoForCard" }, "avs_data": { "$ref": "#/components/schemas/AvsInfo" }, "installment": { "$ref": "#/components/schemas/Installment" }, "saved_account_id": { "type": "integer", "description": "The identifier associated with the corresponding payment instrument in the payment platform" }, "cvv": { "type": "string", "pattern": "^[0-9]{3,4}$", "description": "Card Verification Value/Code (CVV/CVC), intended to verify that the customer has the card in their possession" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "recurring_register": { "description": "Indicator that defines whether the payment should be registered as credential-on-file. Is assigned to the true value to register credential-on-file payment", "type": "boolean" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "sender": { "$ref": "#/components/schemas/SenderInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "addendum": { "$ref": "#/components/schemas/AddendumInitialCard" }, "acs_return_url": { "$ref": "#/components/schemas/ACSReturnUrl" }, "authentication_data": { "$ref": "#/components/schemas/AuthenticationData" }, "recipient": { "$ref": "#/components/schemas/RecipientForCard" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/sale/token": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/sale/token", "operationId": "POST_v2-payment-card-sale-token", "description": "Request for purchase from the customer's card by using its token", "requestBody": { "description": "Payment by token", "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "token" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "allOf": [ { "$ref": "#/components/schemas/CustomerInfoCard" }, { "type": "object", "properties": {}, "required": [ "email", "phone", "screen_res" ] } ] }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfoForCard" }, "token": { "description": "Card token received from the payment platform", "type": "string", "minLength": 1, "maxLength": 255 }, "cvv": { "description": "Card Verification Value/Code (CVV/CVC), intended to verify that the customer has the card in their possession", "type": "string", "pattern": "^[0-9]{3,4}$" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "recurring_register": { "description": "Indicator that defines whether the payment should be registered as credential-on-file. Is assigned to the true value to register credential-on-file payment", "type": "boolean" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "sender": { "$ref": "#/components/schemas/SenderInfoSale" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "addendum": { "$ref": "#/components/schemas/AddendumInitialCard" }, "acs_return_url": { "$ref": "#/components/schemas/ACSReturnUrl" }, "authentication_data": { "$ref": "#/components/schemas/AuthenticationData" }, "recipient": { "$ref": "#/components/schemas/RecipientForCard" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "installment": { "$ref": "#/components/schemas/Installment" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/card/auth": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/auth", "description": "Request for holding funds on the customer's card. The holding of funds can be captured or cancelled by merchant request or automatically if it is specified in merchant project", "operationId": "POST_v2-payment-card-auth", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "card", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "card": { "$ref": "#/components/schemas/CardInfoForSaleAuth" }, "token_data": { "$ref": "#/components/schemas/TokenData" }, "avs_data": { "$ref": "#/components/schemas/AvsInfo" }, "customer": { "allOf": [ { "$ref": "#/components/schemas/CustomerInfoCard" }, { "type": "object", "properties": {}, "required": [ "email", "phone", "screen_res" ] } ] }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfoForCard" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "recurring_register": { "description": "Indicator that defines whether the payment should be registered as credential-on-file. Is assigned to the true value to register credential-on-file payment", "type": "boolean" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "addendum": { "$ref": "#/components/schemas/AddendumInitialCard" }, "acs_return_url": { "$ref": "#/components/schemas/ACSReturnUrl" }, "authentication_data": { "$ref": "#/components/schemas/AuthenticationData" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "installment": { "$ref": "#/components/schemas/Installment" }, "sender": { "$ref": "#/components/schemas/Descriptor" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/auth/saved": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/auth/saved", "description": "Request for holding funds on the customer's saved card", "operationId": "POST_v2-payment-card-auth-saved", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "saved_account_id" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "allOf": [ { "$ref": "#/components/schemas/CustomerInfoCard" }, { "type": "object", "properties": {}, "required": [ "email", "phone", "screen_res" ] } ] }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfoForCard" }, "avs_data": { "$ref": "#/components/schemas/AvsInfo" }, "saved_account_id": { "type": "integer", "description": "The identifier associated with the corresponding payment instrument in the payment platform" }, "cvv": { "type": "string", "pattern": "^[0-9]{3,4}$", "description": "Card Verification Value/Code (CVV/CVC), intended to verify that the customer has the card in their possession" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "recurring_register": { "description": "Indicator that defines whether the payment should be registered as credential-on-file. Is assigned to the true value to register credential-on-file payment", "type": "boolean" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "addendum": { "$ref": "#/components/schemas/AddendumInitialCard" }, "acs_return_url": { "$ref": "#/components/schemas/ACSReturnUrl" }, "authentication_data": { "$ref": "#/components/schemas/AuthenticationData" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "installment": { "$ref": "#/components/schemas/Installment" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/auth/token": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/auth/token", "operationId": "POST_v2-payment-card-auth-token", "description": "Request for holding funds on the customer's saved card by using its token", "requestBody": { "description": "DMS first step by token", "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "token" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "allOf": [ { "$ref": "#/components/schemas/CustomerInfoCard" }, { "type": "object", "properties": {}, "required": [ "email", "phone", "screen_res" ] } ] }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfoForCard" }, "token": { "description": "Card token received from the payment platform", "type": "string", "minLength": 1, "maxLength": 255 }, "cvv": { "description": "Card Verification Value/Code (CVV/CVC), intended to verify that the customer has the card in their possession", "type": "string", "pattern": "^[0-9]{3,4}$" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "recurring_register": { "description": "Indicator that defines whether the payment should be registered as credential-on-file. Is assigned to the true value to register credential-on-file payment", "type": "boolean" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "addendum": { "$ref": "#/components/schemas/AddendumInitialCard" }, "acs_return_url": { "$ref": "#/components/schemas/ACSReturnUrl" }, "authentication_data": { "$ref": "#/components/schemas/AuthenticationData" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "installment": { "$ref": "#/components/schemas/Installment" }, "sender": { "$ref": "#/components/schemas/Descriptor" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/card/capture": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/capture", "description": "Request for debit of the previously held funds on the customer's card", "operationId": "POST_v2-payment-card-capture", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "type": "object", "properties": { "amount": { "type": "integer", "description": "Payment amount, can be equal to, less or more than in the initial auth request. If the amount is less or more than in the auth request a decremental or incremental operation is created automatically" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment currency in ISO 4217 alpha-3 format, must match the currency in the initial auth request" }, "description": { "type": "string", "maxLength": 255, "description": "Payment description or comment" }, "extra_param": { "type": "string", "maxLength": 255, "description": "Parameter for passing additional settings for customise the payment processing flow" } } }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "addendum": { "$ref": "#/components/schemas/Addendum" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/incremental": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/incremental", "description": "Request for changing the amount of payment after holding, before confirm", "operationId": "POST_v2-payment-card-incremental", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoCard" }, "payment": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Amount to increment" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment currency in ISO 4217 alpha-3 format, must be same with currency in auth request" }, "description": { "type": "string", "maxLength": 255, "description": "Payment description" }, "extra_param": { "type": "string", "maxLength": 255, "description": "Parameter for passing additional settings for customise the payment processing flow" } }, "required": [ "currency", "amount" ] }, "addendum": { "$ref": "#/components/schemas/Addendum" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/cancel": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/cancel", "description": "Request to cancel the holding of funds on the customer's card", "operationId": "POST_v2-payment-card-cancel", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "type": "object", "properties": { "amount": { "type": "integer", "description": "Payment amount, can be equal to or less than in the initial auth request. If the amount is less than in the auth request a decremental operation is created automatically" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment currency in ISO 4217 alpha-3 format, must match the currency in auth request" }, "description": { "type": "string", "maxLength": 255, "description": "Payment description or comment" }, "extra_param": { "type": "string", "maxLength": 255, "description": "Parameter for passing additional settings for customise the payment processing flow" } } }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "addendum": { "$ref": "#/components/schemas/Addendum" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/account_verification": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/account_verification", "description": "Request for card verification without performing actual withdrawal", "operationId": "POST_v2-payment-card-account-verification", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "card", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "card": { "$ref": "#/components/schemas/CardInfo" }, "token_data": { "$ref": "#/components/schemas/TokenData" }, "customer": { "type": "object", "description": "Object that contains customer details", "allOf": [ { "$ref": "#/components/schemas/CustomerInfoNameValidation" }, { "type": "object", "required": [ "id" ] } ] }, "payment": { "$ref": "#/components/schemas/AccountVerificationPaymentInfoForCard" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "recurring_register": { "description": "Indicator that defines whether the payment should be registered as credential-on-file. Is assigned to the true value to register credential-on-file payment", "type": "boolean" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "avs_data": { "$ref": "#/components/schemas/AvsInfo" }, "acs_return_url": { "$ref": "#/components/schemas/ACSReturnUrl" }, "authentication_data": { "$ref": "#/components/schemas/AuthenticationData" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "sender": { "$ref": "#/components/schemas/Descriptor" }, "merchant": { "allOf": [ { "$ref": "#/components/schemas/MerchantInfo" }, { "$ref": "#/components/schemas/Descriptor" } ] } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/account_verification/token": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/account_verification/token", "description": "Request for card verification by token without performing actual withdrawal", "operationId": "POST_v2-payment-card-account-verification-by-token", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "token" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "type": "object", "description": "Object that contains customer details", "allOf": [ { "$ref": "#/components/schemas/CustomerInfoNameValidation" }, { "type": "object", "required": [ "id" ] } ] }, "payment": { "$ref": "#/components/schemas/AccountVerificationPaymentInfoForCard" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "recurring_register": { "description": "Indicator that defines whether the payment should be registered as credential-on-file. Is assigned to the true value to register credential-on-file payment", "type": "boolean" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "avs_data": { "$ref": "#/components/schemas/AvsInfo" }, "acs_return_url": { "$ref": "#/components/schemas/ACSReturnUrl" }, "authentication_data": { "$ref": "#/components/schemas/AuthenticationData" }, "token": { "description": "Card token received from the payment platform", "type": "string", "minLength": 1, "maxLength": 255 }, "cvv": { "description": "Card Verification Value/Code (CVV/CVC), intended to verify that the customer has the card in their possession", "type": "string", "pattern": "^[0-9]{3,4}$" }, "card": { "type": "object", "properties": { "stored_card_type": { "$ref": "#/components/schemas/StoredCardType" } } }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "sender": { "$ref": "#/components/schemas/Descriptor" }, "merchant": { "allOf": [ { "$ref": "#/components/schemas/MerchantInfo" }, { "$ref": "#/components/schemas/Descriptor" } ] } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/recurring": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/recurring", "description": "Request to perform regular COF payment from the customer's card", "operationId": "POST_v2-payment-card-recurring", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "type": "object", "description": "Object that contains customer details", "allOf": [ { "$ref": "#/components/schemas/CustomerInfo" }, { "type": "object", "required": [ "id" ] } ] }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfoRecurring" }, { "$ref": "#/components/schemas/CryptoPayment" } ] }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" }, "recurring_id": { "description": "Identifier of the created credential-on-file (COF) purchase. Can be used to perform and manage COF purchasesentifier received from the payment platform", "type": "integer" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "sender": { "$ref": "#/components/schemas/Descriptor" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/recurring/update": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/recurring/update", "description": "Request to update or change recurring payment conditions", "operationId": "POST_v2-payment-card-recurring-update", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringUpdateInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/recurring/cancel": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/recurring/cancel", "description": "Request to cancel recurring payment", "operationId": "POST_v2-payment-card-recurring-cancel", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/merchant_auth": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/merchant_auth", "description": "Request for performing a customer authentication by the payment system on merchant's request", "operationId": "POST_v2-payment-card-merchant_auth", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/MerchantAuthGeneralInfo" }, "confirmation_code": { "type": "string", "minLength": 1, "description": "Authentication confirmation code entered by a customer" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/3ds_check_iframe": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/3ds_check_iframe", "operationId": "POST_v2-payment-card-3ds_check_iframe", "description": "Request to check enrolled card after show iframe", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo3DS" }, "threeds_completion_indicator": { "description": "Indicator that specifies whether the message acknowledging the receipt of the customer's device information was received within 10 seconds after the iframe element was closed. If the acknowledgement was received within 10 seconds, pass `true`; if not, pass `false`", "type": "boolean" }, "md": { "type": "string", "minLength": 1, "description": "Merchant state data. The content of this field must be passed unchanged and without assumptions about its content" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/3ds_result": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/3ds_result", "description": "Request to continue payment processing after 3-D Secure authentication", "operationId": "POST_v2-payment-card-3ds_result", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "general", "cres" ], "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo3DS" }, "cres": { "type": "string", "minLength": 1, "description": "Challenge response - the parameter containing the information about customer's 3‑D Secure 2 authentication result sent in the message from the Access Control Server" }, "md": { "type": "string", "minLength": 1, "description": "Merchant state data received from the payment platform in the callback. The content of this field must be passed unchanged and without assumptions about its content" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } }, { "required": [ "general", "pares" ], "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo3DS" }, "pares": { "type": "string", "minLength": 1, "description": "Payer Authentication Response - the parameter containing the information about customer's 3‑D Secure 1 authentication result sent in the message from the Access Control Server" }, "md": { "type": "string", "description": "Merchant state data received from the payment platform in the callback. The content of this field must be passed unchanged and without assumptions about its content" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } }, { "x-stoplight": { "id": "5ifn7agerbe31" } } ], "type": "object" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/refund": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/refund", "description": "* Request for full or partial refund to the customer's card.\n* Refund is requested in the same currency that the payment was performed.\n* The refund amount can be less than or equal to the amount of the initial payment. The partial refund amount is specified in the parameter `amount`.\n* If the refund amount is not specified in the request, the full amount of the initial payment is refunded", "operationId": "POST_v2-payment-card-refund", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/RefundPaymentInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "addendum": { "$ref": "#/components/schemas/Addendum" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/payout": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/payout", "description": "Request to credit funds to the customer's card", "operationId": "POST_v2-payment-card-payout", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "card", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "card": { "$ref": "#/components/schemas/CardInfoLight" }, "customer": { "$ref": "#/components/schemas/CustomerInfoPayout" }, "sender": { "$ref": "#/components/schemas/SenderInfoPayout" }, "recipient": { "type": "object", "properties": { "country": { "maxLength": 2, "pattern": "^[A-Z]{2}$", "type": "string", "description": "Country code of recipient" }, "address": { "maxLength": 99, "type": "string", "description": "Recipient address" }, "city": { "maxLength": 25, "type": "string", "description": "Name of recipient's address city" }, "state": { "maxLength": 3, "pattern": "^[A-Z]+$", "type": "string", "description": "State code of recipient" }, "first_name": { "type": "string", "maxLength": 255, "description": "Customer first name" }, "last_name": { "type": "string", "maxLength": 255, "description": "Customer last name" } } }, "avs_data": { "$ref": "#/components/schemas/AvsInfo" }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfo" }, { "$ref": "#/components/schemas/CryptoPayment" }, { "type": "object", "description": "Object that contains payment details", "properties": { "purpose": { "type": "string", "maxLength": 12, "description": "Payment purpose code—the parameter is populated if specification of payment purpose is mandatory in issuer country" } } } ] }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "merchant": { "$ref": "#/components/schemas/Descriptor" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/card/payout/token": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/card/payout/token", "description": "Request to credit funds to the customer's card by using its token", "operationId": "POST_v2-payment-card-payout-token", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "token" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoPayout" }, "sender": { "$ref": "#/components/schemas/SenderInfoPayout" }, "recipient": { "type": "object", "properties": { "country": { "maxLength": 2, "pattern": "^[A-Z]{2}$", "type": "string", "description": "Country code of recipient" }, "address": { "maxLength": 99, "type": "string", "description": "Recipient address" }, "city": { "maxLength": 25, "type": "string", "description": "Name of recipient's address city" }, "state": { "maxLength": 3, "pattern": "^[A-Z]+$", "type": "string", "description": "State code of recipient" }, "first_name": { "type": "string", "maxLength": 255, "description": "Customer first name" }, "last_name": { "type": "string", "maxLength": 255, "description": "Customer last name" } } }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfo" }, { "type": "object", "description": "Object that contains payment details", "properties": { "purpose": { "type": "string", "maxLength": 12, "description": "Payment purpose code—the parameter is populated if specification of payment purpose is mandatory in issuer country" } } } ] }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "token": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Card token received from the payment platform" }, "card": { "type": "object", "properties": { "card_holder": { "type": "string", "maxLength": 255, "description": "Name of the cardholder as specified on the payment card" } } }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "merchant": { "$ref": "#/components/schemas/Descriptor" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/individual/payout": { "post": { "tags": [ "Card payments" ], "summary": "/v2/payment/individual/payout", "description": "Request to credit funds to a customer's card by using P2P scheme", "operationId": "POST_v2-payment-individual-payout", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "card", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "card": { "$ref": "#/components/schemas/CardInfoLight" }, "customer": { "$ref": "#/components/schemas/CustomerInfoPayout" }, "sender": { "$ref": "#/components/schemas/SenderInfo" }, "avs_data": { "$ref": "#/components/schemas/AvsInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/customer/card/bytoken": { "post": { "tags": [ "Token operations" ], "summary": "/v2/customer/card/bytoken", "description": "Request for retrieving the saved customer's payment account details by customer's card token in specific project", "operationId": "POST_v2-customer-card-bytoken", "requestBody": { "content": { "application/json": { "schema": { "required": [ "customer", "token" ], "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/CustomerGeneralInfo" }, "token": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Card token received from the payment platform" } }, "description": "Object that contains parameters for receiving of the customer's payment account in the project" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "account", "signature" ], "type": "object", "properties": { "signature": { "type": "string", "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)." }, "account": { "$ref": "#/components/schemas/SavedAccount" } } } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/customer/card/tokenize": { "post": { "tags": [ "Token operations" ], "summary": "/v2/customer/card/tokenize", "description": "Request for the token generation of a customer's card", "operationId": "POST_v2-customer-card-tokenize", "requestBody": { "content": { "application/json": { "schema": { "required": [ "customer", "card" ], "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/TokenizeCustomerInfo" }, "card": { "$ref": "#/components/schemas/CardInfoForTokenize" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid JSON data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/customer/card/token/revoke": { "post": { "tags": [ "Token operations" ], "summary": "/v2/customer/card/token/revoke", "description": "Request for revoking token.", "operationId": "POST_v2-customer-card-token-revoke", "requestBody": { "content": { "application/json": { "schema": { "required": [ "token", "customer" ], "type": "object", "properties": { "token": { "type": "string", "minLength": 1, "maxLength": 255 }, "customer": { "$ref": "#/components/schemas/CustomerGeneralInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid JSON data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/clarification": { "post": { "tags": [ "Additional information submission" ], "summary": "/v2/payment/clarification", "description": "Request to pass the parameters required to make a payment and missed in the previously sent payment request", "operationId": "POST_v2-clarification", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "additional_data" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfoClarification" }, "additional_data": { "$ref": "#/components/schemas/AdditionalData" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/payout/registration": { "post": { "tags": [ "Payment Page payouts" ], "summary": "/v2/payment/payout/registration", "description": "Register payout payment", "operationId": "POST_v2-payment-payout-registration", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "required": [ "payment_id", "project_id", "signature" ], "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "payment_id": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Identifier of the payment, must be unique within project. Any letters, digits, and symbols in UTF-8 encoding can be used" }, "merchant_callback_url": { "type": "string", "minLength": 1, "maxLength": 255, "description": "URL for handling request callbacks. This parameter should be passed when callbacks for a request need to be sent to an address that is different from that specified by default (for information about callbacks and how to use them, see [Handling callbacks](https://developers.ecommpay.com/en/en_platform_callbacks.html))", "example": "https://cosmoshop.earth/specialorder" }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } } }, "customer": { "required": [ "id", "ip_address", "email" ], "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Customer identifier unique within the project" }, "email": { "type": "string", "maxLength": 255, "format": "email", "description": "Customer email address" }, "phone": { "pattern": "^[0-9]{4,24}$", "type": "string", "description": "Customer's phone number, can be 4 to 24 digits long" }, "ip_address": { "type": "string", "maxLength": 255, "format": "ip-address", "description": "Customer IP address" } } }, "payment": { "required": [ "amount", "currency" ], "type": "object", "description": "Object that contains payment details", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Payment amount in minor units of currency" }, "currency": { "type": "string", "pattern": "^[:_A-Z0-9]{3,27}$", "description": "Payment currency in the ISO 4217 alpha-3 format" } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/verification-of-payee/create": { "post": { "tags": [ "Verification of Payee Service" ], "summary": "/v2/verification-of-payee-create", "description": "Request for verification of payee", "operationId": "POST_v2-verification-of-payee-create", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "account" ], "type": "object", "properties": { "general": { "type": "object", "required": [ "project_id", "signature" ], "properties": { "project_id": { "type": "integer", "description": "Identifier of merchant project received from Ecommpay", "minimum": 1, "maximum": 4294967295 }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature generated on the basis of request parameters by using the project secret key. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } } }, "account": { "description": "Object that contains account details", "type": "object", "required": [ "number", "customer_name" ], "properties": { "number": { "type": "string", "description": "Customer's account number", "minLength": 1, "maxLength": 35 }, "customer_name": { "type": "string", "description": "Account owner full name", "minLength": 1, "maxLength": 255 }, "bank_code": { "type": "string", "description": "Bank's IFSC", "minLength": 1, "maxLength": 255 } } }, "payment": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "EUR", "GBP" ], "description": "Payment currency in the ISO 4217 alpha-3 format" } } } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/verification-of-payee/result": { "post": { "tags": [ "Verification of Payee Service" ], "summary": "/v2/verification-of-payee/result", "description": "Request for verification of payee result", "operationId": "POST_v2-verification-of-payee-result", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "vop" ], "type": "object", "properties": { "general": { "type": "object", "required": [ "project_id", "signature" ], "properties": { "project_id": { "type": "integer", "description": "Identifier of merchant project received from Ecommpay", "minimum": 1, "maximum": 4294967295 }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature generated on the basis of request parameters by using the project secret key. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } } }, "vop": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Id of vop" } }, "description": "Object that contains vop fields." } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/session/applepay": { "post": { "tags": [ "Apple Pay" ], "summary": "/v2/session/applepay", "description": "Request for receiving the Apple Pay payment session", "operationId": "POST_v2-session-applepay", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/SessionGeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/ApplePaySessionPaymentInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/applepay/sale": { "post": { "tags": [ "Apple Pay" ], "summary": "/v2/payment/applepay/sale", "description": "Request to debit funds from the customer's card via Apple Pay", "operationId": "POST_v2-payment-applepay-sale", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "etoken" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfo" }, { "$ref": "#/components/schemas/CryptoPayment" } ] }, "etoken": { "$ref": "#/components/schemas/ETokenInfoLight" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "recipient": { "$ref": "#/components/schemas/RecipientForCard" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "sender": { "$ref": "#/components/schemas/Descriptor" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/applepay/auth": { "post": { "tags": [ "Apple Pay" ], "summary": "/v2/payment/applepay/auth", "description": "Request for performing authentication from the customer's card via Apple Pay", "operationId": "POST_v2-payment-applepay-auth", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "etoken" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfo" }, { "$ref": "#/components/schemas/CryptoPayment" } ] }, "etoken": { "$ref": "#/components/schemas/ETokenInfoLight" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "sender": { "$ref": "#/components/schemas/Descriptor" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/applepay/capture": { "post": { "tags": [ "Apple Pay" ], "summary": "/v2/payment/applepay/capture", "description": "Request for performing a customer capture from the customer's card via Apple Pay", "operationId": "POST_v2-payment-applepay-capture", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/applepay/recurring": { "post": { "tags": [ "Apple Pay" ], "summary": "/v2/payment/applepay/recurring", "description": "Request to perform recurring payment from the customer's card via Apple Pay", "operationId": "POST_v2-payment-applepay-recurring", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfo" }, { "$ref": "#/components/schemas/CryptoPayment" } ] }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/applepay/recurring/cancel": { "post": { "tags": [ "Apple Pay" ], "summary": "/v2/payment/applepay/recurring/cancel", "description": "Request to cancel recurring payment from the customer's card via Apple Pay", "operationId": "POST_v2-payment-applepay-recurring-cancel", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/applepay/refund": { "post": { "tags": [ "Apple Pay" ], "summary": "/v2/payment/applepay/refund", "description": "Request to perform refund payment from the customer's card via Apple Pay", "operationId": "POST_v2-payment-applepay-refund", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/RefundPaymentInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/applepay/account_verification": { "post": { "tags": [ "Apple Pay" ], "summary": "/v2/payment/applepay/account_verification", "description": "Request for card verification without performing actual withdrawal via Apple Pay", "operationId": "POST_v2-payment-applepay-account-verification", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "etoken" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoNameValidation" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/AccountVerificationPaymentInfo" }, "etoken": { "$ref": "#/components/schemas/ETokenInfoLight" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "avs_data": { "$ref": "#/components/schemas/AvsInfo" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/applepay/cancel": { "post": { "tags": [ "Apple Pay" ], "summary": "/v2/payment/applepay/cancel", "description": "Request to cancel the holding of funds on the customer's card via Apple Pay", "operationId": "POST_v2-payment-applepay-cancel", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "$ref": "#/components/schemas/CancelPaymentInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/atm/{payment_method}/sale": { "post": { "tags": [ "ATM" ], "summary": "/v2/payment/atm/{payment_method}/sale", "operationId": "POST_v2-payment-atm-payment-method-sale", "description": "Request to debit funds from the customer's card by means of ATMs of the supported banks", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Payment initiation request", "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "return_url" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "account": { "$ref": "#/components/schemas/AccountBankPurchaseInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "card": { "$ref": "#/components/schemas/CardInfoLight" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/atm/{payment_method}/payout": { "post": { "tags": [ "ATM" ], "summary": "/v2/payment/atm/{payment_method}/payout", "operationId": "POST_v2-payment-atm-payment-method-payout", "description": "Request for payout to the customer's card by means of ATMs of the supported banks", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Payout initiation request", "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "account" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoPayout" }, "account": { "$ref": "#/components/schemas/AccountAtmPayoutInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "card": { "$ref": "#/components/schemas/CardInfoLight" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/bancontact/sale": { "post": { "tags": [ "Bancontact" ], "summary": "/v2/payment/bancontact/sale", "description": "Request for payment by using Bancontact", "operationId": "POST_v2-payment-bancontact-sale", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/bancontact/refund": { "post": { "tags": [ "Bancontact" ], "summary": "/v2/payment/bancontact/refund", "description": "Request for refund by using Bancontact", "operationId": "POST_v2-payment-bancontact-refund", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/RefundPaymentInfo" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/banks/{payment_method}/sale": { "post": { "tags": [ "Banks" ], "summary": "/v2/payment/banks/{payment_method}/sale", "operationId": "POST_v2-payment-banks-payment-method-sale", "description": "Request to debit funds from the customer's card in one of the supported banks", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Payment initiation request", "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "account": { "$ref": "#/components/schemas/AccountBankPurchaseInfo" }, "payment": { "$ref": "#/components/schemas/PaymentBanksInfo" }, "return_url": { "oneOf": [ { "$ref": "#/components/schemas/ReturnUrl" }, { "type": "string", "description": "URL to which customer is redirected after payment performing", "minLength": 1 } ] }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/banks/{payment_method}/auth": { "post": { "tags": [ "Banks" ], "summary": "/v2/payment/banks/{payment_method}/auth", "operationId": "POST_v2-payment-banks-payment-method-auth", "description": "Request to debit funds in one of the supported banks", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Payment initiation request", "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "account": { "$ref": "#/components/schemas/AccountBankPurchaseInfo" }, "payment": { "$ref": "#/components/schemas/PaymentBanksInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "return_url": { "oneOf": [ { "$ref": "#/components/schemas/ReturnUrl" }, { "type": "string", "description": "URL to which customer is redirected after payment performing", "minLength": 1 } ] }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "terminal": { "$ref": "#/components/schemas/TerminalInfo" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/banks/{payment_method}/payout": { "post": { "tags": [ "Banks" ], "summary": "/v2/payment/banks/{payment_method}/payout", "operationId": "POST_v2-payment-banks-payment-method-payout", "description": "Request to credit funds to the customer's card in one of the supported banks", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Payout initiation request", "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "account" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoPayout" }, "account": { "$ref": "#/components/schemas/AccountBankPayoutInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "card": { "$ref": "#/components/schemas/CardInfoLight" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/banks/{payment_method}/refund": { "post": { "tags": [ "Banks" ], "summary": "/v2/payment/banks/{payment_method}/refund", "operationId": "POST_v2-payment-banks-payment-method-refund", "description": "Request for refund to the customer's card in one of the supported banks", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Refund initiation request", "content": { "application/json": { "schema": { "required": [ "general", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "$ref": "#/components/schemas/RefundPaymentInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/bank-transfer/{payment_method}/sale": { "post": { "tags": [ "Bank Transfer" ], "summary": "/v2/payment/bank-transfer/{payment_method}/sale", "description": "Request for transferring of funds from the customer's bank account in one of the supported banks", "operationId": "POST_v2-payment-bank-transfer-method-sale", "parameters": [ { "name": "payment_method", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/BankTransferCustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "account": { "$ref": "#/components/schemas/AnotherAccountBankInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/bank-transfer/{payment_method}/payout": { "post": { "tags": [ "Bank Transfer" ], "summary": "/v2/payment/bank-transfer/{payment_method}/payout", "description": "Request for transferring of funds to the customer's bank account in one of the supported banks", "operationId": "POST_v2-payment-bank-transfer-method-payout", "parameters": [ { "name": "payment_method", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoPayout" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "sender": { "$ref": "#/components/schemas/SenderInfo" }, "account": { "$ref": "#/components/schemas/AccountBankInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "additional_data": { "$ref": "#/components/schemas/AdditionalData" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/bank-transfer/{payment_method}/refund": { "post": { "tags": [ "Bank Transfer" ], "summary": "/v2/payment/bank-transfer/{payment_method}/refund", "description": "Request for refund transferring to the customer's bank account in one of the supported banks", "operationId": "POST_v2-payment-bank-transfer-varying-method-refund", "parameters": [ { "name": "payment_method", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/RefundPaymentInfo" }, "account": { "$ref": "#/components/schemas/AccountBankRefundInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/blik/sale": { "post": { "tags": [ "Blik" ], "summary": "/v2/payment/blik/sale", "description": "Request for payment through blik payment method", "operationId": "POST_v2-payment-blik-sale", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/blik/refund": { "post": { "tags": [ "Blik" ], "summary": "/v2/payment/blik/refund", "description": "Request for refund through blik payment method", "operationId": "POST_v2-payment-blik-refund", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/RefundPaymentInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/bnpl/humm/sale": { "post": { "tags": [ "BNPL" ], "summary": "/v2/payment/bnpl/humm/sale", "description": "BNPL sale", "operationId": "POST_v2-payment-bnpl-humm-sale", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "payment", "customer" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoBnplSale" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/cup/union/sale": { "post": { "tags": [ "China UnionPay" ], "summary": "/v2/payment/cup/union/sale", "description": "Request to debit funds from the customer's account in China UnionPay system by using CUP payment method union", "operationId": "POST_v2-payment-cup-union-sale", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "return_url" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "return_url": { "$ref": "#/components/schemas/CupReturnUrl" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/unionpay/refund": { "post": { "tags": [ "China UnionPay" ], "summary": "/v2/payment/unionpay/refund", "operationId": "POST_v2-payment-unionpay-refund", "description": "Request for refund through the UnionPay payment method", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "$ref": "#/components/schemas/RefundPaymentInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/directdebit/{payment_method}/sale": { "post": { "tags": [ "Direct Debit" ], "summary": "/v2/payment/directdebit/{payment_method}/sale", "description": "Request for purchase with mandate registrations", "operationId": "POST_v2-payment-directdebit-payment_method-sale", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringRequiredInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/directdebit/{payment_method}/contract/registration": { "post": { "tags": [ "Direct debit" ], "summary": "/v2/payment/directdebit/{payment_method}/contract/registration", "description": "Request to mandate registrations without making payment", "operationId": "POST_v2-payment-directdebit-payment_method-contract-registration", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfoDirectDebit" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringRequiredInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/directdebit/{payment_method}/recurring": { "post": { "tags": [ "Direct debit" ], "summary": "/v2/payment/directdebit/{payment_method}/recurring", "description": "Request to perform recurring payment from the customer's directdebit account", "operationId": "POST_v2-payment-directdebit-recurring", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" }, "recurring_id": { "description": "Identifier of the created credential-on-file (COF) purchase. Can be used to perform and manage COF purchases", "type": "integer" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/directdebit/{payment_method}/recurring/update": { "post": { "tags": [ "Direct debit" ], "summary": "/v2/payment/directdebit/{payment_method}/recurring/update", "description": "Request to perform recurring payment update info", "operationId": "POST_v2-payment-directdebit-recurring-update", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringUpdateInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/directdebit/{payment_method}/recurring/cancel": { "post": { "tags": [ "Direct debit" ], "summary": "/v2/payment/directdebit/{payment_method}/recurring/cancel", "description": "Request to perform recurring payment cancel", "operationId": "POST_v2-payment-directdebit-recurring-cancel", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/recurring/info": { "post": { "tags": [ "Requests for recurring" ], "summary": "/v2/payment/recurring/info", "description": "Request to get info about recurring payment conditions", "operationId": "POST_v2-payment-recurring-info", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring" ], "type": "object", "properties": { "general": { "type": "object", "description": "Object that contains general request details", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } }, "required": [ "project_id", "signature" ] }, "recurring": { "type": "object", "description": "Object that contains the identifier of the created credential-on-file (COF) purchase. Can be used to perform and manage COF purchases", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Unique identifier of the recurring payment in the payment platform" } }, "required": [ "id" ] } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringInfoSuccess" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/refund": { "post": { "tags": [ "Requests for specific payments" ], "summary": "/v2/payment/refund", "description": "* Request for full or partial refund to the customer's payment method.\n* Refund is requested in the same currency that the payment was performed.\n* The refund amount can be less than or equal to the amount of the initial payment. The partial refund amount is specified in the parameter `amount`.\n* If the refund amount is not specified in the request, the full amount of the initial payment is refunded", "operationId": "POST_v2-payment-refund", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/RefundPaymentInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "addendum": { "$ref": "#/components/schemas/Addendum" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/capture": { "post": { "tags": [ "Requests for specific payments" ], "summary": "/v2/payment/capture", "description": "Request for debit of the previously held funds on the customer's payment method", "operationId": "POST_v2-payment-capture", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "properties": { "amount": { "type": "integer", "description": "Payment amount, can be equal to, less or more than in the initial auth request. If the amount is less or more than in the auth request a decremental or incremental operation is created automatically" }, "currency": { "type": "string", "pattern": "^[:_A-Z0-9]{3,27}$", "description": "Payment currency in ISO 4217 alpha-3 format, must match the currency in the initial auth request" }, "description": { "type": "string", "maxLength": 255, "description": "Payment description or comment" }, "extra_param": { "type": "string", "maxLength": 255, "description": "Extra payment settings parameters. For more information, refer to the Key Account Manager" } } }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "addendum": { "$ref": "#/components/schemas/Addendum" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/googlepay/sale": { "post": { "tags": [ "Google Pay" ], "summary": "/v2/payment/googlepay/sale", "description": "Request to debit funds from the customer's card via Google Pay", "operationId": "POST_v2-payment-googlepay-sale", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "etoken" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfo" }, { "$ref": "#/components/schemas/CryptoPayment" } ] }, "etoken": { "$ref": "#/components/schemas/GooglePayETokenInfoLight" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "recipient": { "$ref": "#/components/schemas/RecipientForCard" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "sender": { "$ref": "#/components/schemas/Descriptor" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/googlepay/auth": { "post": { "tags": [ "Google Pay" ], "summary": "/v2/payment/googlepay/auth", "description": "Request for performing authentication from the customer's card via Google Pay", "operationId": "POST_v2-payment-googlepay-auth", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "etoken" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfo" }, { "$ref": "#/components/schemas/CryptoPayment" } ] }, "etoken": { "$ref": "#/components/schemas/GooglePayETokenInfoLight" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "sender": { "$ref": "#/components/schemas/Descriptor" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/googlepay/capture": { "post": { "tags": [ "Google Pay" ], "summary": "/v2/payment/googlepay/capture", "description": "Request for performing a customer capture from the customer's card via Google Pay", "operationId": "POST_v2-payment-googlepay-capture", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/googlepay/recurring": { "post": { "tags": [ "Google Pay" ], "summary": "/v2/payment/googlepay/recurring", "description": "Request to perform recurring payment from the customer's card via Google Pay", "operationId": "POST_v2-payment-googlepay-recurring", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfo" }, { "$ref": "#/components/schemas/CryptoPayment" } ] }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/googlepay/recurring/cancel": { "post": { "tags": [ "Google Pay" ], "summary": "/v2/payment/googlepay/recurring/cancel", "description": "Request to cancel recurring payment from the customer's card via Google Pay", "operationId": "POST_v2-payment-googlepay-recurring-cancel", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/googlepay/refund": { "post": { "tags": [ "Google Pay" ], "summary": "/v2/payment/googlepay/refund", "description": "Request to perform refund payment from the customer's card via Google Pay", "operationId": "POST_v2-payment-googlepay-refund", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/RefundPaymentInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/payment/googlepay/account_verification": { "post": { "tags": [ "Google Pay" ], "summary": "/v2/payment/googlepay/account_verification", "description": "Request for card verification without performing actual withdrawal via Google Pay", "operationId": "POST_v2-payment-googlepay-account-verification", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "etoken" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoNameValidation" }, "payment": { "$ref": "#/components/schemas/AccountVerificationPaymentInfo" }, "etoken": { "$ref": "#/components/schemas/GooglePayETokenInfoLight" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "avs_data": { "$ref": "#/components/schemas/AvsInfo" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/googlepay/cancel": { "post": { "tags": [ "Google Pay" ], "summary": "/v2/payment/googlepay/cancel/etoken", "description": "Request to cancel the holding of funds on the customer's card via Google Pay", "operationId": "POST_v2-payment-googlepay-cancel", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "$ref": "#/components/schemas/CancelPaymentInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/klarna/sale": { "post": { "tags": [ "Klarna" ], "summary": "/v2/payment/klarna/sale", "description": "Request for payment from Klarna", "operationId": "POST_v2-payment-klarna-sale", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "additional_data": { "$ref": "#/components/schemas/AdditionalData" }, "purchase_data": { "$ref": "#/components/schemas/PurchaseData" }, "terminal": { "$ref": "#/components/schemas/TerminalInfo" }, "additional": { "$ref": "#/components/schemas/KlarnaAdditional" } } } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/klarna/auth": { "post": { "tags": [ "Klarna" ], "summary": "/v2/payment/klarna/auth", "description": "First step DMS for APS", "operationId": "POST_v2-payment-klarna-auth", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "additional_data": { "$ref": "#/components/schemas/AdditionalData" }, "purchase_data": { "$ref": "#/components/schemas/PurchaseData" }, "terminal": { "$ref": "#/components/schemas/TerminalInfo" }, "additional": { "$ref": "#/components/schemas/KlarnaAdditional" } } } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/klarna/capture": { "post": { "tags": [ "Klarna" ], "summary": "/v2/payment/klarna/capture", "description": "Second step DMS for APS", "operationId": "POST_v2-payment-klarna-capture", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "$ref": "#/components/schemas/CancelPaymentInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "purchase_data": { "$ref": "#/components/schemas/PurchaseData" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/klarna/cancel": { "post": { "tags": [ "Klarna" ], "summary": "/v2/payment/klarna/cancel", "description": "Cancel step DMS for APS", "operationId": "POST_v2-payment-klarna-cancel", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "$ref": "#/components/schemas/CancelPaymentInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/online-banking/{payment_method}/sale": { "post": { "tags": [ "Online banking" ], "summary": "/v2/payment/online-banking/{payment_method}/sale", "description": "Request for payment from customer's online bank account in one of the supported banks", "operationId": "POST_v2-payment-online-banking-payment_method-sale", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "receipt_data": { "$ref": "#/components/schemas/ReceiptData" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "recurring_register": { "description": "Indicator that defines whether the payment should be registered as credential-on-file. Is assigned to the true value to register credential-on-file payment", "type": "boolean" }, "additional_data": { "$ref": "#/components/schemas/AdditionalData" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/online-banking/{payment_method}/refund": { "post": { "tags": [ "Online banking" ], "summary": "/v2/payment/online-banking/{payment_method}/refund", "description": "Request for refund to the customer's online bank account in one of the supported banks", "operationId": "POST_v2-payment-online-banking-payment_method-refund", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/RefundPaymentInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/pix/sale": { "post": { "tags": [ "Pix" ], "summary": "/v2/payment/pix/sale", "description": "Request for payment through the Pix payment method", "operationId": "POST_v2-payment-pix-sale", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/pix/payout": { "post": { "tags": [ "Pix" ], "summary": "/v2/payment/pix/payout", "description": "Request for payout through the Pix payment method", "operationId": "POST_v2-payment-pix-payout", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "account": { "$ref": "#/components/schemas/AccountBankInfo" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/invoice/create": { "post": { "tags": [ "Payment links" ], "summary": "/v2/payment/invoice/create", "description": "Request to create an invoice payment", "operationId": "POST_v2-payment-invoice-create", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfoInvoice" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoInvoice" }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfoInvoice" }, { "$ref": "#/components/schemas/CryptoPayment" } ] }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "operation_type": { "type": "string", "enum": [ "sale", "auth", "contract registration" ], "description": "Operation type for customer to pay. Default is sale." }, "send_email": { "type": "boolean", "description": "Send automatic email to customer or not" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" }, "recipient": { "$ref": "#/components/schemas/RecipientForCard" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Payload parsing or data structure error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/invoice/card/token/create": { "post": { "tags": [ "Payment links" ], "summary": "/v2/payment/invoice/card/token/create", "operationId": "POST_v2-payment-invoice-card-token-create", "description": "Create invoice payment by token", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "token" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfoInvoice" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoInvoice" }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfoInvoiceByToken" }, { "$ref": "#/components/schemas/CryptoPayment" } ] }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recipient": { "$ref": "#/components/schemas/RecipientForCard" }, "token": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Token of the customer's card in Gate" }, "operation_type": { "type": "string", "enum": [ "sale", "auth" ], "description": "Operation type for customer to pay. Default is sale." }, "send_email": { "type": "boolean", "description": "Send automatic email to customer or not" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "booking_info": { "$ref": "#/components/schemas/BookingInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Payload parsing or data structure error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/invoice/cancel": { "post": { "tags": [ "Payment links" ], "summary": "/v2/payment/invoice/cancel", "operationId": "POST_v2-payment-invoice-cancel", "description": "Request to cancel invoice payment", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfoInvoice" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Payload parsing or data structure error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/skrill/sale": { "post": { "tags": [ "Skrill" ], "summary": "/v2/payment/skrill/sale", "description": "Request for payment through the Skrill payment method", "operationId": "POST_v2-payment-skrill-sale", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "return_url" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/skrill/1-tap": { "post": { "tags": [ "Skrill" ], "summary": "/v2/payment/skrill/1-tap", "description": "Request for OneClick payment through the Skrill payment method", "operationId": "POST_v2-payment-skrill-1-tap", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "general", "customer", "payment", "recurring" ], "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/skrill/recurring/update": { "post": { "tags": [ "Skrill" ], "summary": "/v2/payment/skrill/recurring/update", "description": "Request to update or change recurring conditions of the payment through the Skrill payment method", "operationId": "POST_v2-payment-skrill-recurring-update", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringUpdateInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/skrill/recurring/cancel": { "post": { "tags": [ "Skrill" ], "summary": "/v2/payment/skrill/recurring/cancel", "description": "Request to cancel recurring payment through the Skrill payment method", "operationId": "POST_v2-payment-skrill-recurring-cancel", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/skrill/payout": { "post": { "tags": [ "Skrill" ], "summary": "/v2/payment/skrill/payout", "description": "Request for payout through the Skrill payment method", "operationId": "POST_v2-payment-skrill-payout", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "account", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/SkrillCustomerInfo" }, "account": { "$ref": "#/components/schemas/AccountInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/skrill/refund": { "post": { "tags": [ "Skrill" ], "summary": "/v2/payment/skrill/refund", "description": "Request for refund through the Skrill payment method", "operationId": "POST_v2-payment-skrill-refund", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "account", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/SkrillCustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "account": { "$ref": "#/components/schemas/AccountInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/vietqr/sale": { "post": { "tags": [ "VietQR" ], "summary": "/v2/payment/vietqr/sale", "description": "Request for sale through vietqr payment method", "operationId": "POST_v2-payment-vietqr-sale", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "terminal": { "$ref": "#/components/schemas/TerminalInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/wallet/{payment_method}/sale": { "post": { "tags": [ "Wallet" ], "summary": "/v2/payment/wallet/{payment_method}/sale", "description": "Request for payment via methods that support e-wallets", "operationId": "POST_v2-payment-wallet-paymentmethod-sale", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "account": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AccountInfo" }, { "type": "object", "properties": { "customer_name": { "type": "string", "description": "Account owner full name" } } } ] }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "addendum": { "$ref": "#/components/schemas/AddendumData" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/wallet/{payment_method}/auth": { "post": { "tags": [ "Wallet" ], "summary": "/v2/payment/wallet/{payment_method}/auth", "description": "First step DMS for APS", "operationId": "POST_v2-payment-wallet-paymentmethod-auth", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "return_url" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "account": { "$ref": "#/components/schemas/AccountInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/wallet/{payment_method}/capture": { "post": { "tags": [ "Wallet" ], "summary": "/v2/payment/wallet/{payment_method}/capture", "description": "First step DMS for APS", "operationId": "POST_v2-payment-wallet-paymentmethod-capture", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "properties": { "amount": { "type": "integer", "description": "Payment amount, can be equal to, less or more than in the initial auth request. If the amount is less or more than in the auth request a decremental or incremental operation is created automatically" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment currency in ISO 4217 alpha-3 format, must match the currency in the initial auth request" } } } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/wallet/{payment_method}/cancel": { "post": { "tags": [ "Wallet" ], "summary": "/v2/payment/wallet/{payment_method}/cancel", "description": "Cancel step DMS for APS", "operationId": "POST_v2-payment-wallet-paymentmethod-cancel", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "payment": { "$ref": "#/components/schemas/CancelPaymentInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" }, "callback": { "$ref": "#/components/schemas/CallbackInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/wallet/{payment_method}/sale/1click": { "post": { "tags": [ "Wallet" ], "summary": "/v2/payment/wallet/{payment_method}/sale/1click", "description": "Request for OneClick payment through the payment method that supports such payments by using e-wallets", "operationId": "POST_v2-payment-wallet-payment-method-sale-1click", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "saved_account_id" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoWithId" }, "account": { "$ref": "#/components/schemas/AccountInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringInfo" }, "saved_account_id": { "type": "integer" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/wallet/{payment_method}/recurring": { "post": { "tags": [ "Wallet" ], "summary": "/v2/payment/wallet/{payment_method}/recurring", "description": "Request to perform regular payment from the customer's e-wallet", "operationId": "POST_v2-payment-wallet-payment-method-recurring", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "payment", "customer", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoWalletRecurring" }, "account": { "$ref": "#/components/schemas/AccountInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/wallet/{payment_method}/1-tap": { "post": { "tags": [ "Wallet" ], "summary": "/v2/payment/wallet/{payment_method}/1-tap", "description": "Request for OneClick payment through the payment method that supports such payments by using e-wallets", "operationId": "POST_v2-payment-wallet-payment-method-1-tap", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/wallet/{payment_method}/recurring/update": { "post": { "tags": [ "Wallet" ], "summary": "/v2/payment/wallet/{payment_method}/recurring/update", "description": "Request to update or change recurring conditions of the payment through the payment method that supports such payments by using e-wallets", "operationId": "POST_v2-payment-recurring-update", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringUpdateInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/wallet/{payment_method}/recurring/cancel": { "post": { "tags": [ "Wallet" ], "summary": "/v2/payment/wallet/{payment_method}/recurring/cancel", "description": "Request to cancel recurring payments through the payment method that supports such payments by using e-wallets", "operationId": "POST_v2-payment-recurring-cancel", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "recurring": { "$ref": "#/components/schemas/RecurringIdInfo" }, "interface_type": { "$ref": "#/components/schemas/SourceInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/wallet/{payment_method}/refund": { "post": { "tags": [ "Wallet" ], "summary": "/v2/payment/wallet/{payment_method}/refund", "description": "Request for refund to the customer's e-wallet", "operationId": "POST_v2-payment-wallet-refund", "parameters": [ { "name": "payment_method", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "merchant": { "$ref": "#/components/schemas/MerchantInfo" }, "payment": { "$ref": "#/components/schemas/RefundPaymentInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/wallet/{payment_method}/payout": { "post": { "tags": [ "Wallet" ], "summary": "/v2/payment/wallet/{payment_method}/payout", "description": "Request for payout via methods that use e-wallets", "operationId": "POST_v2-payment-wallet-payment-method-payout", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "customer", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfoPayout" }, "account": { "$ref": "#/components/schemas/AccountInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" }, "return_url": { "$ref": "#/components/schemas/ReturnUrl" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GateSuccessResponse" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/customer/info": { "post": { "tags": [ "Requests for customer details" ], "summary": "/v2/customer/info", "description": "Request for retrieving customer data by customer identifier within the project", "operationId": "POST_v2-customer-info", "requestBody": { "content": { "application/json": { "schema": { "required": [ "customer" ], "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/CustomerGeneralInfo" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "customer", "signature" ], "type": "object", "properties": { "customer": { "required": [ "ip_address", "project_id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Customer identifier unique within the project" }, "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123 }, "country": { "pattern": "^[A-Z]{2}$", "type": "string", "description": "Customer country code in the ISO 3166-1 alpha-2 format" }, "phone": { "pattern": "^[0-9]{4,24}$", "type": "string", "description": "Customer's phone number, can be 4 to 24 digits long" }, "email": { "maxLength": 255, "type": "string", "description": "Customer email address", "format": "email" }, "day_of_birth": { "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "type": "string", "description": "Customer's date of birth. This parameter is specified in DD-MM-YYYY format", "example": "12-12-1990" }, "first_name": { "maxLength": 255, "type": "string", "description": "Customer first name" }, "last_name": { "maxLength": 255, "type": "string", "description": "Customer last name" }, "address": { "maxLength": 255, "type": "string", "description": "Customer address" }, "zip": { "maxLength": 255, "type": "string", "description": "Customer address postal code" }, "city": { "maxLength": 256, "type": "string", "description": "Name of customer's address city" }, "street": { "maxLength": 256, "type": "string", "description": "Street of customer address" }, "browser": { "maxLength": 512, "type": "string", "description": "A string that identifies the customer browser information" }, "ip_address": { "maxLength": 255, "type": "string", "description": "Customer IP address, both IPv4 and IPv6 are supported", "format": "ip-address" }, "billing": { "type": "object", "properties": { "country": { "pattern": "^[A-Z]{2}$", "type": "string", "description": "Country code of the customer's billing address in ISO 3166-1 alpha-2 format" }, "region": { "type": "string", "description": "The region or state of the customer's billing address" }, "city": { "type": "string" }, "address": { "type": "string" }, "postal": { "type": "string" } }, "description": "Billing info" }, "created_at": { "type": "string" } } }, "signature": { "type": "string", "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)." } } } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/customer/saved_account/list": { "post": { "tags": [ "Requests for customer details" ], "summary": "/v2/customer/saved_account/list", "description": "Request for retrieving saved customer's payment instruments in the project", "operationId": "POST_v2-customer-saved_account-list", "requestBody": { "content": { "application/json": { "schema": { "required": [ "customer", "payment_method" ], "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/CustomerGeneralInfo" }, "payment_method": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Identifier of the payment method in the payment platform" } }, "description": "Object that contains customer details" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "accounts", "signature" ], "type": "object", "properties": { "signature": { "type": "string", "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)." }, "accounts": { "type": "array", "description": "Array that contains information about the customer's saved payment accounts", "items": { "$ref": "#/components/schemas/SavedAccount" } } } } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorItems" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/customer/saved_account/delete": { "post": { "tags": [ "Requests for customer details" ], "summary": "/v2/customer/saved_account/delete", "description": "Request for removal of saved card or other saved account of the customer", "operationId": "POST_v2-customer-saved_account-delete", "requestBody": { "content": { "application/json": { "schema": { "required": [ "customer", "saved_account_id" ], "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/CustomerGeneralInfo" }, "saved_account_id": { "type": "integer", "description": "The ID of the customer's saved account received from the payment platform" }, "payment_method": { "type": "string", "default": "card", "enum": [ "card" ], "description": "Payment method type for saved accounts set" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "message", "status" ], "type": "object", "properties": { "status": { "type": "string", "description": "Status of removing of the saved used account" }, "message": { "type": "string", "description": "Notification of the removal of the saved customer's account" } }, "description": "" } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorItems" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/payment/status": { "post": { "tags": [ "Requests for information", "sync" ], "summary": "/v2/payment/status", "description": "Request for retrieving the status and other data of the payment. Keep in mind that depending on the individual settings of the project the format of the response may vary. Presented below is the default format of the response", "operationId": "POST_v2-payment-status", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "destination": { "type": "string", "enum": [ "merchant", "terminal" ], "default": "merchant", "description": "Destination of notification (terminal, merchant, etc.)" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentStatusResponse" } } } }, "400": { "description": "Validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorItems" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid JSON data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/info/available-methods/{payment_direction}/list": { "post": { "tags": [ "Requests for information", "sync" ], "summary": "/v2/info/available-methods/{payment_direction}/list", "description": "Returns availability of requested payment methods", "operationId": "POST_v2-info-available-methods-list", "parameters": [ { "name": "payment_direction", "in": "path", "description": "Payment direction", "required": true, "schema": { "type": "string", "enum": [ "payin", "payout" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "description": "Object that contains general request details", "type": "object", "required": [ "project_id", "signature" ], "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } } }, "payment_method_list": { "type": "array", "description": "Array of elements containing information about requested payment methods", "items": { "type": "object", "required": [ "payment_method" ], "properties": { "payment_method": { "type": "string", "description": "Payment method code" } } } } } } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "description": "Array that contains information about payment methods", "items": { "type": "object", "properties": {} } } } } }, "400": { "description": "Validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorItems" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid JSON data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/info/banks/bycountry": { "post": { "tags": [ "Requests for information", "sync" ], "summary": "/v2/info/banks/bycountry", "operationId": "POST_v2-info-banks-bycountry", "description": "Returns bank list broken down by country", "requestBody": { "content": { "application/json": { "schema": { "required": [ "project_id", "signature", "country" ], "type": "object", "properties": { "project_id": { "type": "integer" }, "signature": { "type": "string" }, "country": { "type": "string", "format": "[A-Z][A-Z][A-Z]" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {} } } } } }, "400": { "description": "Validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid JSON data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/info/banks/byaggregator": { "post": { "tags": [ "Requests for information", "sync" ], "summary": "/v2/info/banks/byaggregator", "operationId": "POST_v2-info-banks-byaggregator", "description": "Returns bank list broken down by aggregator", "requestBody": { "content": { "application/json": { "schema": { "required": [ "project_id", "aggregator_id", "signature" ], "type": "object", "properties": { "project_id": { "type": "integer" }, "aggregator_id": { "type": "integer" }, "signature": { "type": "string", "minLength": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {} } } } } }, "400": { "description": "Validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid JSON data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/info/banks/bypaymentmethod": { "post": { "tags": [ "Requests for information", "sync" ], "summary": "/v2/info/banks/bypaymentmethod", "operationId": "POST_v2-info-banks-bypaymentmethod", "description": "Returns bank list broken down by payment method", "requestBody": { "content": { "application/json": { "schema": { "required": [ "project_id", "payment_method_id", "signature" ], "type": "object", "properties": { "project_id": { "type": "integer" }, "payment_method_id": { "type": "integer" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Currency in ISO 4217 alpha-3 format" }, "type": { "type": "string" }, "signature": { "type": "string", "minLength": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {} } } } } }, "400": { "description": "Validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid JSON data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/info/banks/byprovider": { "post": { "tags": [ "Requests for information", "sync" ], "summary": "/v2/info/banks/byprovider", "operationId": "POST_v2-info-banks-byprovider", "description": "Returns bank list broken down by provider", "requestBody": { "content": { "application/json": { "schema": { "required": [ "project_id", "provider_id", "signature" ], "type": "object", "properties": { "project_id": { "type": "integer" }, "provider_id": { "type": "integer" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Currency in ISO 4217 alpha-3 format" }, "type": { "type": "string" }, "signature": { "type": "string", "minLength": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {} } } } } }, "400": { "description": "Validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid JSON data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/info/banks/{payment_method}/{operationType}/list": { "post": { "tags": [ "Requests for information", "sync" ], "summary": "/v2/info/banks/{payment_method}/{operationType}/list", "operationId": "POST_v2-info-banks-payment-method-operationType-list", "description": "Request to retrieve the list of banks available for the specified payment method and operation type", "parameters": [ { "name": "payment_method", "in": "path", "description": "Payment method", "required": true, "schema": { "type": "string" } }, { "name": "operationType", "in": "path", "description": "Operation type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentBanksInfo" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {} } } } } }, "400": { "description": "Validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid JSON data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list": { "post": { "tags": [ "Requests for information", "sync" ], "summary": "/v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list", "operationId": "POST_v2-info-banks-parentMethod-childMethod-operationType-list", "description": "Request to retrieve the list of banks available for the specified payment method and operation type (for groupped methods)", "parameters": [ { "name": "parentMethod", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "childMethod", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "operationType", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "payment" ], "type": "object", "properties": { "general": { "$ref": "#/components/schemas/GeneralInfo" }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "payment": { "$ref": "#/components/schemas/PaymentInfo" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {} } } } } }, "400": { "description": "Validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid JSON data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-codegen-request-body-name": "request" } }, "/v2/recurring/retry-custom-schedule/save": { "post": { "tags": [ "Requests for recurring" ], "summary": "/v2/recurring/retry-custom-schedule/save", "description": "Request to save custom recurring retry schedule", "operationId": "POST_v2-recurring-retry-custom-schedule-save", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "interval_days" ], "type": "object", "properties": { "general": { "required": [ "project_id", "signature" ], "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } }, "description": "Object that contains general request details" }, "interval_days": { "type": "array", "minItems": 1, "maxItems": 10, "uniqueItems": true, "description": "The schedule by days when retry attempts for charging funds should be made", "items": { "type": "integer", "minimum": 1, "maximum": 10 } } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "status" ], "type": "object", "properties": { "status": { "maxLength": 255, "type": "string" } } } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/recurring/retry-custom-schedule/info": { "post": { "tags": [ "Requests for recurring" ], "summary": "/v2/recurring/retry-custom-schedule/info", "description": "Request to get custom recurring retry schedule", "operationId": "POST_v2-recurring-retry-custom-schedule-info", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "required": [ "project_id", "signature" ], "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } }, "description": "Object that contains general request details" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "project_id", "schedule" ], "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of merchant project received from Ecommpay" }, "schedule": { "type": "object", "properties": { "interval_days": { "type": "array", "description": "The schedule by days when retry attempts for charging funds should be made", "items": { "type": "integer" } }, "status": { "type": "string", "enum": [ "active", "disabled" ] } } } } }, "examples": { "Example 1": { "value": { "project_id": 0, "schedule": { "interval_days": [ 1 ], "status": "active" } } } } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/recurring/retry-custom-schedule/disable": { "post": { "tags": [ "Requests for recurring" ], "summary": "/v2/recurring/retry-custom-schedule/disable", "description": "Request to disable custom recurring retry schedule", "operationId": "POST_v2-recurring-retry-custom-schedule-disable", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general" ], "type": "object", "properties": { "general": { "required": [ "project_id", "signature" ], "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } }, "description": "Object that contains general request details" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "status" ], "type": "object", "properties": { "status": { "maxLength": 255, "type": "string" } } } } } }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v2/recurring/retry_stop": { "post": { "tags": [ "Requests for recurring" ], "summary": "/v2/recurring/retry_stop", "description": "Request for restrict retry operation", "operationId": "POST_v2-recurring-retry_stop", "requestBody": { "content": { "application/json": { "schema": { "required": [ "general", "recurring", "trigger_operation_id" ], "type": "object", "properties": { "general": { "type": "object", "description": "Object that contains general request details", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } }, "required": [ "project_id", "signature" ] }, "recurring": { "type": "object", "description": "Object that contains Identifier of the created credential-on-file (COF) purchase. Can be used to perform and manage COF purchasesentifier", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Unique identifier of the recurring payment in the payment platform" } }, "required": [ "id" ] }, "trigger_operation_id": { "description": "Identifier of operation which initiated retry", "type": "integer" } } } } }, "required": false }, "responses": { "200": { "description": "OK" }, "400": { "description": "Data validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid data structure or JSON parsing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "components": { "schemas": { "AccountInfo": { "required": [ "number" ], "type": "object", "properties": { "number": { "type": "string", "maxLength": 100, "minLength": 1, "description": "Customer's account number", "example": "21312" }, "save": { "type": "boolean", "default": false, "description": "Indicator specifying whether the customer's account details should be saved" } }, "description": "Object that contains the minimum required details of the customer's payment instrument - account/wallet/voucher etc." }, "AccountAtmPayoutInfo": { "description": "Object that contains account information for payout performing by using ATMs", "type": "object", "properties": { "bank_id": { "type": "integer", "minimum": 1, "description": "Bank identifier received from the payment platform" }, "customer_name": { "type": "string", "description": "Account owner full name", "minLength": 1 }, "branch": { "type": "string", "description": "Bank branch", "maxLength": 255 }, "number": { "type": "string", "description": "Customer's account number", "example": "21312", "minLength": 1 }, "region_id": { "type": "integer", "minimum": 1, "description": "Region or state identifier of the bank branch location received from the payment platform", "example": 3 }, "city": { "type": "string", "maxLength": 255, "description": "Bank branch city code" } }, "required": [ "bank_id", "region_id" ] }, "AccountBankInfo": { "description": "Object that contains the account details of bank which is used for payment processing", "allOf": [ { "$ref": "#/components/schemas/AccountInfo" }, { "type": "object", "properties": { "type": { "type": "string", "maxLength": 255, "description": "Account type." }, "bank_id": { "type": "integer", "minimum": 1, "description": "Bank identifier received from the payment platform", "example": 137 }, "customer_name": { "type": "string", "description": "First name and last name of the account holder", "example": "John Johnson" }, "security_code": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Payment confirmation code. Some payment methods may require this parameter (depending on the methods themselves)", "example": "852923" }, "swift_code": { "type": "string", "minLength": 8, "maxLength": 11, "description": "SWIFT bank identification code" }, "routing_number": { "type": "string", "maxLength": 255, "description": "Identifier of the bank in the transfer system" }, "routing_type": { "type": "string", "maxLength": 255, "description": "Type of bank transfer. Possible values: `ACH CODE`—for the USA, `BANK CODE`—for Honkong, `BSB CODE`—for Australia, `IFSC`—for India, `SORT CODE`—for Great Britain, `TRANSIT NUMBER`—for Canada, `BRANCH CODE`—for Brazil, `SWIFT`—for other countries that support this method." }, "iban": { "type": "string", "minLength": 5, "maxLength": 34, "description": "International bank account number" }, "bank_name": { "type": "string", "description": "Name of the financial institution that issued the card", "example": "CITIGROUP" }, "bank_branch_name": { "type": "string", "description": "Name of the bank branch" }, "bank_branch_code": { "type": "string", "description": "Code of the bank branch" }, "bank_branch_city": { "type": "string", "description": "City of the bank branch's location" }, "bank_branch_address": { "type": "string", "description": "Address of bank branch" }, "bank_code": { "type": "string", "description": "International bank identifier (BIC or SWIFT) or, in certain countries, a specific code used by the national interbank clearing center", "example": "1234" }, "fin": { "type": "string", "description": "Financial institution number" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country code in the ISO 3166-1 alpha-2 format" } } } ] }, "AccountBankPayoutInfo": { "description": "Object that contains the details of the customer's bank account for payout performing", "allOf": [ { "$ref": "#/components/schemas/AccountInfo" }, { "type": "object", "properties": { "bank_id": { "type": "integer", "minimum": 1, "description": "Bank identifier received from the payment platform" }, "customer_name": { "type": "string", "description": "Account owner full name", "minLength": 1 }, "branch": { "type": "string", "description": "Bank branch", "maxLength": 255 }, "number": { "type": "string", "description": "Customer's account number", "example": "21312", "minLength": 1 }, "region_id": { "type": "integer", "minimum": 1, "description": "Region or state identifier of the bank branch location received from the payment platform", "example": 3 }, "city": { "type": "string", "maxLength": 255, "description": "Bank branch city code" }, "bank_code": { "type": "string", "minLength": 1, "maxLength": 255, "description": "International bank identifier (BIC or SWIFT) or, in certain countries, a specific code used by the national interbank clearing center", "example": "1234" }, "bank_address": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Address of bank location" }, "bik": { "type": "string", "minLength": 9, "maxLength": 9, "description": "Bank code on the Russian Federation" }, "bank_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Name of the financial institution that issued the card", "example": "CITIGROUP" }, "branch_code": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Bank branch code" }, "native_customer_name": { "type": "string", "description": "Native account owner full name", "minLength": 1 } } } ] }, "AccountBankPurchaseInfo": { "type": "object", "properties": { "bank_id": { "type": "integer", "minimum": 0, "description": "Bank identifier received from the payment platform" }, "number": { "type": "string", "description": "Customer's account number", "example": "21312", "minLength": 1 }, "bank_code": { "type": "string", "description": "International bank identifier (BIC or SWIFT) or, in certain countries, a specific code used by the national interbank clearing center", "example": "1234" }, "customer_name": { "type": "string", "description": "Account owner full name", "minLength": 1 } }, "description": "Object that contains the details of the customer's bank account for payment performing" }, "AccountBankRefundInfo": { "type": "object", "properties": { "bank_id": { "type": "integer", "minimum": 0, "description": "Bank identifier received from the payment platform" }, "number": { "type": "string", "description": "Customer's account number", "example": "21312", "minLength": 1 }, "customer_name": { "type": "string", "description": "Account owner full name", "minLength": 1 } }, "description": "Object that contains the details of the customer's bank account for refund performing" }, "AccountInfoAtMerchant": { "type": "object", "properties": { "additional": { "type": "string", "maxLength": 64, "description": "Additional information about the customer's account in free text such as its identifier" }, "date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Date created account. Format: DD-MM-YYYY" }, "loyalty_level": { "type": "string", "description": "User loyalty level" }, "change_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Date of the most recent change of account data, excluding password updates or resets. Format: DD-MM-YYYY" }, "pass_change_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Date of the most recent password change or reset. Format: DD-MM-YYYY" }, "purchase_number": { "type": "integer", "maximum": 9999, "description": "Number of purchases made via the customer's account in the last 6 months, 4 characters maximum" }, "provision_attempts": { "type": "integer", "maximum": 999, "description": "Number of attempts to add a new card to a customer's account in the last 24 hours" }, "activity_day": { "type": "integer", "maximum": 999, "description": "Number of payment attempts in the last 24 hours" }, "activity_year": { "type": "integer", "maximum": 999, "description": "Number of payment attempts in the last 365 days" }, "payment_age": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Card record creation date. Format: DD-MM-YYYY" }, "suspicious_activity": { "type": "string", "pattern": "^0[1-2]$", "description": "Indicator specifying whether the merchant has experienced suspicious activity on the cardholder account. Possible values: `01` —no suspicious activity detected, `02`—suspicious activity detected" }, "auth_method": { "type": "string", "pattern": "^(0[1-4]|0[1-4][1-6])$", "description": "Indicator specifying how the customer was authenticated during their most recent login to the web service. Possible values: `01`—no authentication, `02`—logging in with authentication data kept on file by the merchant,`03`—logging in with the federated identity credentials (for example, Google Account or Facebook ID), `04`—logging in with the use of FIDO authenticator (Fast Identity Online)" }, "auth_time": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}\\d{2}:\\d{2}$", "description": "Date and time of the customer's most recent account login. Format: DD-MM-YYYYhh:mm", "example": "01-10-202213:12" }, "auth_data": { "type": "string", "maxLength": 255, "description": "Additional login information in free text" }, "age_indicator": { "type": "string", "pattern": "^0[1-5]$", "description": "Number of days since the customer account was created. Possible values: `01`—guest checkout, `02`—the account was created at the moment of making a payment, `03`—fewer than 30 days, `04`—between 30 and 60 day, `05`—more than 60 days" }, "change_indicator": { "type": "string", "pattern": "^0[1-4]$", "description": "Number of days since the most recent change to the account, except for the password change or password reset. Possible values: `01`—the account was updated on the day when the payment was made, `02`—fewer than 30 days, `03`—between 30 and 60 days, `04`—more than 60 days" }, "pass_change_indicator": { "type": "string", "pattern": "^0[1-5]$", "description": "Number of days since the most recent password change or reset. Possible values: `01`—password was not changed or reset, `02`—password was changed or reset on the day when the payment was made, `03`—fewer than 30 days, `04`—between 30 and 60 days, `05`—more than 60 days" }, "payment_age_indicator": { "type": "string", "pattern": "^0[1-5]$", "description": "Number of days since the payment card details were saved to a customer's account. Possible values: 01—guest checkout, 02—card details were saved on the day when the payment was made, 03—fewer than 30 days, 04—between 30 and 60 days, 05—more than 60 days" }, "purchase_history": { "$ref": "#/components/schemas/PurchaseHistoryInfo" }, "device_purchase_history": { "$ref": "#/components/schemas/PurchaseHistoryInfo" } }, "description": "An object that contains account data in merchant's web service." }, "AccountVerificationPaymentInfo": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0, "maximum": 0, "description": "Payment amount in minor currency units, should be passed with zero value" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment currency code in ISO 4217 alpha-3 format" }, "description": { "type": "string", "maxLength": 255, "description": "Payment description or comment" }, "debt_account": { "type": "string", "maxLength": 10, "description": "The number of the account designated to receive funds as part of the debt settlement purchases", "example": "an9876170i" } }, "description": "Stub object that contains necessary details for payment instrument verification. Amount should be passed with zero value" }, "AccountVerificationPaymentInfoForCard": { "allOf": [ { "$ref": "#/components/schemas/AccountVerificationPaymentInfo" }, { "$ref": "#/components/schemas/CryptoPayment" }, { "type": "object", "description": "Stub object that contains necessary details for payment instrument verification. Amount should be passed with zero value", "properties": { "debt_account": { "type": "string", "maxLength": 10, "description": "The number of the account designated to receive funds as part of the debt settlement purchases", "example": "an9876170i" } } }, { "$ref": "#/components/schemas/MotoInfo" } ] }, "ACSReturnUrl": { "type": "object", "properties": { "return_url": { "type": "string", "description": "Return url for authenticated status" }, "3ds_notification_url": { "type": "string", "description": "Url for callback from ACS" } } }, "AddendumData": { "type": "object", "properties": { "lodging": { "oneOf": [ { "$ref": "#/components/schemas/AddendumLodgingInitial" }, { "type": "array", "items": { "$ref": "#/components/schemas/AddendumLodgingInitial" } } ] }, "airlines": { "oneOf": [ { "$ref": "#/components/schemas/AddendumAirlines" }, { "type": "array", "items": { "$ref": "#/components/schemas/AddendumAirlines" } } ] }, "professional_services": { "oneOf": [ { "$ref": "#/components/schemas/AddendumProfessionalServices" }, { "type": "array", "items": { "$ref": "#/components/schemas/AddendumProfessionalServices" } } ] }, "retail": { "oneOf": [ { "$ref": "#/components/schemas/AddendumRetail" }, { "type": "array", "items": { "$ref": "#/components/schemas/AddendumRetail" } } ] } } }, "Addendum": { "type": "object", "properties": { "lodging": { "$ref": "#/components/schemas/AddendumLodging" } } }, "AddendumAirlines": { "required": [ "departure_airport", "departure_date", "departure_time", "ticket", "trip_leg" ], "type": "object", "properties": { "departure_date": { "type": "string", "maxLength": 10, "pattern": "^(?:\\d{2})(1[012]|0?[1-9])(3[01]|[12][0-9]|0?[1-9])$", "description": "Departure date in YYMMDD format" }, "departure_airport": { "type": "string", "maxLength": 3, "description": "Originating airport name’s standard abbreviation" }, "departure_time": { "type": "string", "maxLength": 4, "pattern": "^([0-1][0-9]|2[0-3])[0-5][0-9]$", "description": "Time of departure provided by the airline. Format: HHMM" }, "arrival_time": { "type": "string", "maxLength": 4, "pattern": "^([0-1][0-9]|2[0-3])[0-5][0-9]$", "description": "Arrival time provided by the airline: Format: HHMM" }, "endorsements_restr": { "type": "string", "maxLength": 20, "description": "" }, "exchange_ticket": { "type": "string", "maxLength": 15, "description": "Original ticket number replaced by a new ticket number" }, "ticket": { "$ref": "#/components/schemas/AddendumAirlinesTicket" }, "trip_leg": { "$ref": "#/components/schemas/AddendumAirlinesTripLeg" } } }, "AddendumAirlinesTicket": { "required": [ "customer_ref", "issuing_carrier", "passenger_name", "ticket_number" ], "type": "object", "properties": { "passenger_name": { "type": "string", "maxLength": 20, "description": "Name of the passenger to whom the ticket was issued" }, "ticket_number": { "type": "string", "maxLength": 15, "description": "Number on the ticket" }, "issuing_carrier": { "type": "string", "maxLength": 2, "description": "Standard abbreviation for the airline carrier issuing the ticket" }, "customer_ref": { "type": "string", "maxLength": 25, "description": "Number or code that identifies the customer or consumer." }, "travel_agency_code": { "type": "string", "maxLength": 8, "description": "Code assigned to the travel agency" }, "travel_agency_name": { "type": "string", "maxLength": 25, "description": "Name of the travel agency issuing the ticket" }, "restricted_ticket_indicator": { "type": "boolean", "description": "Identifier noting that the ticket purchased has some restriction associated with its use" }, "ticket_issue_date": { "type": "string", "maxLength": 10, "pattern": "^(3[01]|[12][0-9]|0?[1-9])-(1[012]|0?[1-9])-((?:19|20)\\d{2})$", "description": "Date in which the Ticket was Issued" }, "total_tax_amount": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Tax amount for a line item, specified in minor units of currency", "example": 1800 } } }, "AddendumAirlinesTripLeg": { "required": [ "carrier_code", "destination_airport", "fare_bassis", "flight_number", "service_class", "stop_over_code" ], "type": "object", "properties": { "carrier_code": { "type": "string", "maxLength": 2, "description": "Standard abbreviation for the airline carrier" }, "service_class": { "type": "string", "maxLength": 1, "pattern": "^([F|J|Y|W])$", "description": "Service type (such as coach or first class)" }, "destination_airport": { "type": "string", "maxLength": 3, "description": "Destination airport name’s standard abbreviation" }, "stop_over_code": { "type": "boolean", "description": "Code indicating whether there was a direct or a non-direct flight or route on the same ticket number" }, "fare_bassis": { "type": "string", "maxLength": 6, "description": "Code that carriers assign to a particular ticket type, such as business class or discounted/nonrefundable" }, "flight_number": { "type": "string", "maxLength": 5, "description": "Number that the operating or marketing carrier assigned" } } }, "AddendumInitialCard": { "type": "object", "description": "Available to merchants with eligible MCCs", "properties": { "airlines": { "$ref": "#/components/schemas/AddendumAirlinesCard" }, "lodging": { "$ref": "#/components/schemas/AddendumLodgingInitial" } } }, "AddendumAirlinesCard": { "required": [ "ticket_number", "passenger_name", "customer_ref", "ticket_issuer_code", "ticket_issue_date", "trip_legs" ], "type": "object", "properties": { "ticket_number": { "type": "string", "maxLength": 15, "description": "Ticket number assigned by the issuer", "example": "1051426005635" }, "passenger_name": { "type": "string", "maxLength": 20, "description": "Full passenger name (name and last name, title if available)", "example": "EDDINGTON/ARTHUR MR" }, "ticket_issuer_code": { "type": "string", "maxLength": 2, "description": "IATA 2-character code of the airline that issued the ticket", "example": "AY" }, "ticket_issue_date": { "type": "string", "format": "date", "description": "Date of ticket issuance, in ISO 8601 (YYYY-MM-DD) format", "example": "2025-10-04" }, "customer_ref": { "type": "string", "maxLength": 25, "description": "Identifier of the passenger record in the reservation system", "example": "T7H3PD" }, "travel_agency_code": { "type": "string", "maxLength": 8, "description": "IATA-accreditation code assigned to a travel agency", "example": "2921540" }, "travel_agency_name": { "type": "string", "maxLength": 25, "description": "Name of the travel agency that issued the ticket", "example": "Deep Sky Tours" }, "restricted_ticket_indicator": { "type": "boolean", "description": "Indicator that specifies refund restrictions applied to the ticket, (i.e. the ticket is non-refundable or can be returned)", "example": true }, "computerized_reservation_system": { "type": "string", "maxLength": 4, "description": "Code of the computerised reservation system, may be needed for payments in Germany, (STRT – Start, PARS – TWA, DATS – Delta, SABR – Sabre, DALA – Covia-Apollo, BLAN – Dr. Blank, DERD – DER, TUID – TUI)", "example": "TUID" }, "total_fare_amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Total amount of the ticket", "example": 23500 }, "total_tax_amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Amount of all the taxes associated with the ticket", "example": 135 }, "total_fees_amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Amount of the fees associated with the ticket", "example": 1447 }, "trip_legs": { "required": [ "trip_leg1" ], "type": "object", "properties": { "trip_leg1": { "$ref": "#/components/schemas/AddendumAirlinesCardTripLeg" }, "trip_leg2": { "$ref": "#/components/schemas/AddendumAirlinesCardTripLeg" }, "trip_leg3": { "$ref": "#/components/schemas/AddendumAirlinesCardTripLeg" }, "trip_leg4": { "$ref": "#/components/schemas/AddendumAirlinesCardTripLeg" } } } } }, "AddendumAirlinesCardTripLeg": { "required": [ "flight_number", "carrier_code", "departure_airport", "departure_at", "destination_airport", "arrival_at", "stop_over_code", "service_class", "fare_bassis" ], "type": "object", "properties": { "flight_number": { "type": "string", "maxLength": 5, "description": "The flight number assigned by operating or marketing carrier. Airline carrier code must not be included", "example": "156" }, "carrier_code": { "type": "string", "maxLength": 2, "description": "2-character IATA carrier code", "example": "AY" }, "departure_airport": { "type": "string", "maxLength": 3, "description": "3-character IATA code of the departure airport", "example": "IVL" }, "departure_at": { "type": "string", "format": "date-time", "description": "Date and time of departure, in the YYYY-MM-DDThh:mm:ss±hh:mm format (according to ISO 8601)", "example": "2025-10-31T16:05:00+02:00" }, "destination_airport": { "type": "string", "maxLength": 3, "description": "3-character IATA code of the destination airport", "example": "PFO" }, "arrival_at": { "type": "string", "format": "date-time", "description": "Date and time of arrival, in the YYYY-MM-DDThh:mm:ss±hh:mm format (according to ISO 8601)", "example": "2025-10-31T20:15:00+02:00" }, "stop_over_code": { "type": "boolean", "description": "Indicates whether the flight is direct (no stopover) or non-direct (includes stopover)", "example": true }, "service_class": { "type": "string", "maxLength": 1, "description": "IATA code of service class (R – Supersonic, P – First Class Premium, F – First Class, A – First Class Discounted; J – Business Class Premium, C – Business Class, {D, I, Z} – Business Class Discounted; W – Economy/Coach Premium, {S, Y} – Economy/Coach, {B, H, K, L, M, N, Q, T, V, X} – Economy/Coach Discounted)", "example": "Y" }, "fare_bassis": { "type": "string", "maxLength": 6, "description": "Particular fare applied by the carrier", "example": "YE3MFI" }, "exchange_ticket": { "type": "string", "maxLength": 15, "description": "The original ticket number replaced by a new ticket number (if applicable)", "example": "3904082308998" }, "conjunct_ticket": { "type": "string", "maxLength": 15, "description": "The ticket that contains additional coupons on an itinerary that is more than four segments (if present)", "example": "6065511855011" }, "coupon_number": { "type": "string", "maxLength": 3, "pattern": "\\d", "description": "Number of a coupon assigned to the leg inside the ticket", "example": "1" }, "endorsements_restr": { "type": "string", "maxLength": 20, "description": "Added notation specifying any relevant information about restrictions, additional data, and endorsement information", "example": "No changes allowed" } } }, "AddendumLodging": { "type": "object", "properties": { "check_out_date": { "maxLength": 19, "pattern": "^(3[01]|[12][0-9]|0?[1-9])-(1[012]|0?[1-9])-((?:19|20)\\d{2})$", "type": "string", "description": "Customer's check-out date in the dd-mm-yyyy format", "example": "22-12-2019" }, "room": { "type": "object", "properties": { "rate": { "maximum": 999999999999, "type": "integer", "description": "Daily room charges exclusive of taxes and fees. Is used to calculate base lodging cost. This psrsmeter is provided in minor units of currency", "example": 12 }, "number_of_nights": { "maximum": 99, "minimum": 1, "type": "integer", "description": "Total number of nights for which a room was contracted during a lodging stay", "example": 10 } } }, "total_tax": { "maximum": 999999999999, "minimum": 0, "type": "number", "description": "Total amount of sales tax or value added tax (VAT) on the total purchase amount. This parameter is provided in minor units of the payment's currency" }, "charges": { "$ref": "#/components/schemas/AddendumLodgingCharges" } }, "description": "Available only if MCC is 3501-3999 or 7011" }, "AddendumLodgingCharges": { "type": "object", "properties": { "room_service": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of the room service charges. This parameter provided in minor units of currency" }, "bar_or_lounge": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of the lounge or bar charges. This parameter provided in minor units of currency" }, "transportation": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of the transportation charges. This parameter provided in minor units of currency" }, "gratuity": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of the gratuity charges. This parameter provided in minor units of currency" }, "conference_room": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of the charges associated with conference room use. This parameter provided in minor units of currency" }, "audio_or_visual": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of the audiovisual equipment charges. This parameter provided in minor units of currency" }, "banquet": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of the banquet charges. This parameter provided in minor units of currency" }, "internet_access": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of the Internet access charges. This parameter provided in minor units of currency" }, "early_departure": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount charged because of early departure. This parameter provided in minor units of currency" }, "phone": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of charges for all phone calls. This parameter provided in minor units of currency" }, "restaurant": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of all restaurant charges. This parameter provided in minor units of currency" }, "minibar": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of in-room “mini-bar” service charges. This parameter provided in minor units of currency" }, "gift_shop": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of all gift shop and specialty shop charges. This parameter provided in minor units of currency" }, "laundry_or_cleaning": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount of cleaning charges. This parameter provided in minor units of currency" }, "valet": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Charges associated with the use of valet services. This parameter provided in minor units of currency" }, "movie": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount charged for in-room movies. This parameter provided in minor units of currency" }, "business_center": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount charged for business center use and supplies. This parameter provided in minor units of currency" }, "health_club": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Amount charged for health club use and supplies. This parameter provided in minor units of currency" } } }, "AddendumLodgingInitial": { "required": [ "check_in_date", "check_out_date", "customer_service_toll_free_number", "fire_safety_act_indicator", "folio_number", "room" ], "type": "object", "properties": { "customer_service_toll_free_number": { "type": "string", "maxLength": 17, "description": "A toll-free phone number for the customer service of the booked hotel or other type of accommodation", "example": "18005553535" }, "hotel_name": { "type": "string", "maxLength": 255, "description": "Name of the hotel or other type of accommodation where the customer is staying", "example": "Best Eastern" }, "check_in_date": { "type": "string", "maxLength": 19, "pattern": "^(3[01]|[12][0-9]|0?[1-9])-(1[012]|0?[1-9])-((?:19|20)\\d{2})$", "description": "Customer's check-in date in the dd-mm-yyyy format", "example": "10-12-2019" }, "check_out_date": { "type": "string", "maxLength": 19, "pattern": "^(3[01]|[12][0-9]|0?[1-9])-(1[012]|0?[1-9])-((?:19|20)\\d{2})$", "description": "Customer's check-out date in the dd-mm-yyyy format", "example": "22-12-2019" }, "folio_number": { "type": "string", "maxLength": 25, "description": "Card acceptor’s internal invoice or billing ID reference number", "example": "56265655ABC" }, "room": { "description": "Object with room details", "properties": { "tax": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "Tax amount information such as the daily room tax, occupancy tax, energy tax, and tourist tax amounts", "example": 25 }, "rate": { "type": "integer", "maximum": 999999999999, "description": "Daily room charges exclusive of taxes and fees. this parameter is used to calculate base lodging cost and is provided in minor units of currency", "example": 12 }, "number_of_nights": { "type": "integer", "minimum": 1, "maximum": 99, "description": "Total number of nights for which room was contracted during lodging stay" } }, "required": [ "rate" ] }, "fire_safety_act_indicator": { "type": "boolean", "description": "Facility complies with the Hotel and Motel Fire Safety Act of 1990 (PL101-391) or similar legislation" }, "guest_name": { "type": "string", "maxLength": 40, "description": "Customer full name" }, "guest_number": { "type": "string", "maxLength": 25, "description": "Number assigned to the lodging customer" }, "billing_adjustment": { "type": "string", "maxLength": 12, "description": "Additional charges incurred after the cardholder departure" }, "property_phone_number": { "type": "string", "maxLength": 17, "description": "Specific lodging property location by its local phone number" }, "no_show_indicator": { "type": "boolean", "description": "Customer did not show up after making lodging reservation" }, "prepaid_expenses": { "type": "integer", "maximum": 999999999999, "description": "Amount of deposit or other prepaid amounts for the lodging stay. This parameter is provided in minor units of currency." }, "total_tax": { "type": "number", "minimum": 0, "maximum": 999999999999, "description": "The amount of all the taxes associated with the lodging. Applicable only to the Visa, Visa Electron and Maestro cards. Not applicable for Mastercard. This parameter is provided in minor units of the payment's currency" }, "charges": { "$ref": "#/components/schemas/AddendumLodgingCharges" } }, "description": "Available only if MCC is 3501-3999 or 7011" }, "AddendumProfessionalServices": { "required": [ "admission_notice_url" ], "type": "object", "properties": { "admission_notice_url": { "type": "string", "description": "Admission notice url" } } }, "AddendumRetail": { "required": [ "goods", "quantity" ], "type": "object", "properties": { "goods": { "type": "string", "description": "Name goods" }, "quantity": { "type": "integer", "description": "Quantity goods" } } }, "AdditionalData": { "type": "object", "properties": { "avs_data": { "$ref": "#/components/schemas/AvsInfo" } }, "description": "Object that contains additional payment information submission for payment processing. The object can contain any objects requested by the payment platform as specified in the **clarification_fields** object" }, "AnotherAccountBankInfo": { "description": "Object that contains the account details of bank which is used for payment processing. Used when account number is not required.", "allOf": [ { "$ref": "#/components/schemas/AnotherAccountInfo" }, { "type": "object", "properties": { "type": { "type": "string", "maxLength": 255, "description": "Account type." }, "bank_id": { "oneOf": [ { "type": "string", "minLength": 1, "description": "Bank identifier received from the payment platform" }, { "type": "integer", "minimum": 1, "description": "Bank identifier" } ] }, "customer_name": { "type": "string", "description": "Bank account's owner full name" }, "security_code": { "type": "string", "minLength": 1, "maxLength": 255, "description": "First 2 digits of the password" }, "swift_code": { "type": "string", "minLength": 8, "maxLength": 11, "description": "SWIFT bank identification code" }, "routing_number": { "type": "string", "maxLength": 255, "description": "Bank account's routing number" }, "routing_type": { "type": "string", "maxLength": 255, "description": "Bank account's routing type" }, "iban": { "type": "string", "minLength": 5, "maxLength": 34, "description": "International bank account number" }, "bank_name": { "type": "string", "description": "Name of the financial institution that issued the card", "example": "CITIGROUP" }, "bank_branch_name": { "type": "string", "description": "Bank branch name" }, "bank_branch_code": { "type": "string", "description": "Bank branch code" }, "bank_branch_city": { "type": "string", "description": "City of bank branch location" }, "bank_branch_address": { "type": "string", "description": "Address of bank branch location" }, "bank_code": { "type": "string", "description": "International bank identifier (BIC or SWIFT) or, in certain countries, a specific code used by the national interbank clearing center", "example": "1234" }, "fin": { "type": "string", "description": "Financial institution number" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country code in the ISO 3166-1 alpha-2 format" } } } ] }, "AnotherAccountInfo": { "type": "object", "properties": { "number": { "type": "string", "maxLength": 100, "minLength": 1, "description": "Customer's account number", "example": "21312" }, "save": { "type": "boolean", "default": false, "description": "Indicator specifying whether the customer's account details should be saved" } }, "description": "Object that contains the minimum required details of the customer's payment instrument - account/wallet/voucher etc. Used when account number is not required." }, "ApplePaySessionPaymentInfo": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0, "maximum": 10000000000000, "description": "Payment amount in minor units of currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment currency code in the ISO 4217 alpha-3 format" }, "customer_amount": { "type": "integer", "minimum": 0, "maximum": 10000000000000, "description": "Payment amount converted into the currency selected by the customer. This parameter is specified in minor units of currency" }, "description": { "type": "string", "maxLength": 255, "description": "Payment description or comment for additional data analisys by using Dashboard" }, "extra_param": { "type": "string", "maxLength": 255, "description": "Parameter for passing additional settings for customise the payment processing flow" }, "best_before": { "type": "string", "format": "date-time", "description": "Payment expiration date in the date-time format according to the ISO 8601 standart" }, "challenge_indicator": { "type": "string", "pattern": "^0[1-9]$", "description": "Indicates whether the challenge flow is preferred. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "challenge_window": { "type": "string", "pattern": "^0[1-5]$", "description": "The dimensions of a window in which the authentication page opens. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "reorder": { "type": "string", "pattern": "^0[1-2]$", "description": "Indicates whether the customer is buying the merchandise or the service for the first time or it is a repeat purchase. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "preorder_purchase": { "type": "string", "pattern": "^0[1-2]$", "description": "Parameter specifying whether the current purchase is pre-ordered. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "preorder_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Date when the preordered merchandise or service will be available in the DD-MM-YYYY format" }, "gift_card": { "$ref": "#/components/schemas/GiftCardInfo" }, "device_channel": { "type": "string", "pattern": "^0[1-3]$", "description": "Indicator that specifies the type of the interface through which the web service initiates the 3-D Secure authentication. By default, it is set to `02` (Browser-based). In specific cases that must be agreed upon and approved, the value of this parameter can be `01` (App-based) and `03` (3DS Requestor Initiated). If `01` or `03` value is passed when it was not initially agreed upon, the payment may get declined" } }, "description": "Object that contains payment details" }, "AuthenticationData": { "required": [ "xid" ], "type": "object", "properties": { "cavv": { "type": "string", "maxLength": 255, "description": "Cardholder authentication verification value. Mandatory if `authentication_status`=`Y` or `A`" }, "ds_operation_id": { "type": "string", "maxLength": 36, "description": "Operation identifier assigned by the Directory Server" }, "eci": { "type": "string", "enum": [ "00", "01", "02", "05", "06", "07" ], "description": "The electronic commerce indicator" }, "threeds_version": { "type": "string", "enum": [ "3ds_1", "3ds_2", "non_3ds" ], "description": "Indicator of the 3‑D Secure authentication" }, "xid": { "type": "string", "maxLength": 255, "description": "The operation identifier (Base64-encoded, 20 bytes in a decoded form)" }, "enrollement_status": { "type": "string", "enum": [ "Y", "N", "U" ], "description": "The enrollment response from the VERes message from the directory server ('Y','N','U'). Supported for 3D Secure 1" }, "authentication_status": { "type": "string", "enum": [ "Y", "U", "A" ], "description": "Customer's authentication status. Possible values: `Y`—the cardholder was successfully authenticated by their card issuer, `A`—the cardholder authentication was attempted, `U`—the card issuer was unavailable during the authentication attempt" }, "authentication_flow": { "type": "string", "enum": [ "Frictionless", "Challenge" ], "description": "The indicator of the flow that was used for the customer 3-D Secure 2 authentication on the merchant side within the operation being processed" }, "threeds_full_version": { "type": "string", "description": "The full version of the 3-D Secure protocol", "example": "2.3.1", "maxLength": 8, "minLength": 5, "pattern": "^(\\d{1,2})\\.(\\d{1,2})\\.(\\d{1,2})(\\.(\\d{1,2}))?$" }, "authentication_status_reason_code": { "type": "string", "description": "Reason code for `authentication_status`", "maxLength": 2, "minLength": 2, "example": "01" } }, "description": "Object that contains 3DS Authentication Data from merchant" }, "AvsInfo": { "required": [ "avs_post_code", "avs_street_address" ], "type": "object", "properties": { "avs_post_code": { "type": "string", "description": "Postal code of the customer", "example": "WS13 6LG", "minLength": 1 }, "avs_street_address": { "type": "string", "description": "Address of the customer", "example": "4 Breadmarket Street", "minLength": 1 } }, "description": "Object that contains customer details for verification by the Address Verification Service. For more information, see [AVS Check](https://developers.ecommpay.com/en/en_Gate_avs.html)" }, "BankTransferCustomerInfo": { "allOf": [ { "$ref": "#/components/schemas/CustomerInfo" }, { "type": "object", "properties": { "building": { "type": "string", "maxLength": 255, "description": "Customer building number" } } } ] }, "BookingInfo": { "type": "object", "description": "Object that contains general booking details", "properties": { "bookers": { "type": "array", "description": "List of customers included in the booking", "additionalProperties": false, "uniqueItems": true, "items": { "type": "object", "description": "Object that contains booker details", "additionalProperties": false, "properties": { "first_name": { "maxLength": 255, "type": "string", "description": "First name of the customer provided at the time of booking", "example": "William" }, "last_name": { "maxLength": 255, "type": "string", "description": "Last name of the customer provided at the time of booking", "example": "Herschel" }, "email": { "maxLength": 255, "type": "string", "format": "email", "description": " Email provided at the time of booking", "example": "rsfellow@mail.com" } } } }, "items": { "type": "array", "description": "List of services included in the booking", "additionalProperties": false, "uniqueItems": true, "items": { "type": "object", "description": "Object that contains the details of each service included in the booking", "additionalProperties": false, "properties": { "description": { "type": "string", "maxLength": 255, "description": "Description of the service included in the booking", "example": "VIP Arrival" }, "start_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Starting date of the service included in the booking, in the DD-MM-YYYY format", "example": "12-08-2026" }, "end_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Ending date of the service included in the booking, in the DD-MM-YYYY format", "example": "12-08-2026" } } } }, "start_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Starting date of the booked service, in the DD-MM-YYYY format", "example": "12-08-2026" }, "end_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Ending date of the booked service, in the DD-MM-YYYY format", "example": "13-08-2026" }, "description": { "type": "string", "maxLength": 255, "description": "Free-form description of the booked service", "example": "Siders music festival full pass" }, "total": { "type": "integer", "description": "The total cost of the booking in minor units of currency. Value cannot be`0`", "example": 200000 }, "pax": { "type": "integer", "description": "Number of people per booking. Value cannot be `0`", "example": 4 }, "reference": { "type": "string", "maxLength": 255, "description": " Booking reference, which can be the URL, the name of the booked service, or its code in the merchant's web service", "example": "musicfestlink" }, "id": { "type": "string", "maxLength": 255, "description": "Identifier of the booking, unique in the merchant's web service", "example": "83" } } }, "CallbackInfo": { "type": "object", "properties": { "delay": { "type": "integer", "description": "Delay time for sending callbacks, in seconds", "example": 42, "minimum": 0, "maximum": 600 }, "force_disable": { "type": "boolean", "description": "Indicator for disabling callbacks. Possible values: `true`—for disabling callbacks with information about the given payment, and `false`—for enabling these callbacks" } }, "description": "Object that contains additional callback sending conditions" }, "CancelPaymentInfo": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Refund amount in minor currency units" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Currency code in ISO-4217 alpha-3 format" }, "description": { "type": "string", "maxLength": 255, "description": "Refund description or comment" } }, "description": "Object that contains information about refund" }, "CardInfo": { "required": [ "month", "pan", "year" ], "type": "object", "properties": { "pan": { "type": "string", "format": "pan", "maxLength": 32, "description": "For cards - the number of the payment card used for payment. Specified as is, without masked characters, spaces, or other separators. For network tokens - the token without masked characters, spaces, or other separator", "example": "4314220000000056" }, "year": { "type": "integer", "minimum": 2020, "maximum": 9999, "description": "For cards - the year of the card's expiration date. For network tokens - the year of the token's expiration date (according to the Gregorian calendar)" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "description": "For cards - the month of the card's expiration date. For network tokens - the month of the token's expiration date" }, "card_holder": { "type": "string", "maxLength": 255, "description": "Name of the cardholder as specified on the payment card" }, "cvv": { "type": "string", "pattern": "^[0-9]{3,4}$", "description": "Card Verification Value/Code (CVV/CVC), intended to verify that the customer has the card in their possession" }, "security_code": { "type": "string", "pattern": "^[0-9]{2}$", "description": "First 2 digits of the password." }, "save": { "type": "boolean", "description": "Indicator specifying whether the customer's account details should be saved" }, "stored_card_type": { "$ref": "#/components/schemas/StoredCardType" } }, "description": "Object that contains the information about customer's card that is used for payment. Contains parameters to specify card details or the information about the network token associated with the card" }, "CardInfoForSaleAuth": { "required": [ "month", "pan", "year" ], "type": "object", "properties": { "pan": { "type": "string", "format": "pan", "maxLength": 32, "description": "For cards - the number of the payment card used for payment. Specified as is, without masked characters, spaces, or other separators. For network tokens - the token without masked characters, spaces, or other separator", "example": "4314220000000056" }, "year": { "type": "integer", "minimum": 2020, "maximum": 9999, "description": "For cards - the year of the card's expiration date. For network tokens - the year of the token's expiration date (according to the Gregorian calendar)" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "description": "For cards - the month of the card's expiration date. For network tokens - the month of the token's expiration date" }, "card_holder": { "type": "string", "maxLength": 255, "description": "Name of the cardholder as specified on the payment card" }, "cvv": { "type": "string", "pattern": "^[0-9]{3,4}$", "description": "Card Verification Value/Code (CVV/CVC), intended to verify that the customer has the card in their possession" }, "security_code": { "type": "string", "pattern": "^[0-9]{2}$", "description": "First 2 digits of the password" }, "save": { "type": "boolean", "description": "Indicator specifying whether the customer's account details should be saved" }, "scheme_id": { "type": "string", "pattern": "^[a-zA-Z0-9 ]{1,15}$", "description": "Specialised identifier of the initial operation of the COF purchase registration assigned by the global card network" }, "transaction_link_id": { "type": "string", "minLength": 22, "maxLength": 22, "pattern": "^[0-9A-Za-z_\\-]*$", "description": "Specialised identifier of the COF purchase series assigned by the global card network, used for processing Mastercard payments, its value corresponds to the Transaction Link Identifier (TLID)", "example": "a7F9k3L2-Q8vB6pT1_WzYc" }, "stored_card_type": { "$ref": "#/components/schemas/StoredCardType" } }, "description": "Object that contains the information about customer's card that is used for payment. Contains parameters to specify card details or the information about the network token associated with the card" }, "CardInfoForTokenize": { "required": [ "month", "pan", "year" ], "type": "object", "properties": { "pan": { "type": "string", "format": "pan", "maxLength": 32, "description": "Number of the payment card used for payment. Specified as is, without masked characters, spaces, or other separators", "example": "4314220000000056" }, "year": { "type": "integer", "minimum": 2020, "maximum": 9999, "description": "Year of the card's expiration date, intended to indicate the last valid year for card usage" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "description": "Month of the card's expiration date, intended to indicate the last valid month for card usage" }, "card_holder": { "type": "string", "maxLength": 255, "description": "Name of the cardholder as specified on the payment card" } }, "description": "Object that contains the customer's card details that is used for tokenize" }, "CardInfoLight": { "required": [ "pan" ], "type": "object", "properties": { "pan": { "type": "string", "format": "pan", "maxLength": 32, "description": "Number of the payment card used for payment. Specified as is, without masked characters, spaces, or other separators", "example": "4314220000000056" }, "year": { "type": "integer", "minimum": 2020, "maximum": 9999, "description": "Year of the card's expiration date, intended to indicate the last valid year for card usage" }, "month": { "type": "integer", "minimum": 1, "maximum": 12, "description": "Month of the card's expiration date, intended to indicate the last valid month for card usage" }, "issue_year": { "type": "integer", "maximum": 9999, "description": "Year of issuing date of the card" }, "issue_month": { "type": "integer", "minimum": 1, "maximum": 12, "description": "Month of issuing date of the card" }, "card_holder": { "type": "string", "maxLength": 255, "description": "Name of the cardholder as specified on the payment card" }, "cvv": { "type": "string", "pattern": "^[0-9]{3,4}$", "description": "Card Verification Value/Code (CVV/CVC), intended to verify that the customer has the card in their possession" }, "save": { "type": "boolean", "description": "Indicator specifying whether the customer's account details should be saved" }, "stored_card_type": { "$ref": "#/components/schemas/StoredCardType" } }, "description": "Object that contains the customer's card details that is used for payment" }, "CupReturnUrl": { "allOf": [ { "$ref": "#/components/schemas/ReturnUrl" }, { "type": "object", "required": [ "success" ] } ] }, "CustomerGeneralInfo": { "required": [ "id", "project_id", "signature" ], "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "id": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Customer identifier unique within the project" }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } }, "description": "Object that contains general customer details in merchant project" }, "CustomerInfo": { "description": "Object that contains customer details", "allOf": [ { "$ref": "#/components/schemas/CustomerInfoBase" }, { "type": "object", "required": [ "ip_address" ] } ] }, "CustomerInfoBase": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 255, "description": "Customer identifier unique within the project" }, "identification_level": { "type": "string", "maxLength": 255, "description": "Indicator specifying whether the customer is trusted; provided by the merchant. Example: `1`—the customer is trusted" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Customer's country code in the ISO 3166-1 alpha-2 format", "example": "GB" }, "city": { "type": "string", "maxLength": 256, "description": "Name of customer's address city" }, "state": { "type": "string", "maxLength": 256, "description": "Name of the region (state, province, or other administrative subdivision type) of the customer's address", "example": "Greater London" }, "phone": { "type": "string", "pattern": "^[0-9]{4,24}$", "description": "Customer's phone number, can be 4 to 24 digits long" }, "iin": { "type": "string", "maxLength": 255, "description": "Customer's individual identification number. Issued by the government or other official authority. Can be used for identity verification, regulatory compliance, and fraud prevention checks" }, "home_phone": { "type": "string", "pattern": "^[0-9]{4,24}$", "description": "Customer's home phone number, can be 4 to 24 digits long" }, "work_phone": { "type": "string", "pattern": "^[0-9]{4,24}$", "description": "Customer's work phone number, can be 4 to 24 digits long" }, "save": { "type": "boolean", "description": "Indicator specifying whether the customer's account details should be saved" }, "account_save": { "type": "boolean", "description": "Indicator specifying whether the customer's account details should be saved" }, "day_of_birth": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Customer's date of birth. This parameter is specified in DD-MM-YYYY format", "example": "12-12-1990" }, "person_type": { "type": "string", "maxLength": 255, "description": "Type of the customer as a legal person, for example, a company or an individual, used for compliance" }, "birthplace": { "type": "string", "maxLength": 255, "description": "Name of the customer's birthplace (e.g., town, city, or other settlement type)", "example": "London" }, "first_name": { "type": "string", "maxLength": 255, "description": "First name of the customer", "example": "Jane" }, "middle_name": { "type": "string", "maxLength": 255, "description": "Middle, second, or patronymic name of the customer", "example": "Mary" }, "last_name": { "type": "string", "maxLength": 255, "description": "Last name of the customer", "example": "Smith" }, "email": { "type": "string", "maxLength": 255, "format": "email", "description": "Email address of the customer. The string consists of a local-part and a domain name, separated by the `@` symbol", "example": "helen@example.com" }, "browser": { "type": "string", "maxLength": 512, "description": "Name and version of the customer's browser used to access the web service. Can be used to identify the customer environment for risk and fraud analysis" }, "ip_address": { "type": "string", "maxLength": 255, "format": "ip-address", "description": "IP address of the customer's device. Can be used for security checks, geolocation, and fraud prevention" }, "device_type": { "type": "string", "description": "Browser engine that can be used for rendering web pages", "example": "WebKit" }, "device_id": { "type": "string", "description": "Identifier of the customer's device" }, "datetime": { "type": "string", "format": "dateTime", "description": "Date and time when the payment form was opened by the customer in the YYYY-MM-DD hh-mm-ss format. Useful for tracking customer activity and timing of payment initiation", "example": "2022-01-01 15:15:15" }, "screen_res": { "type": "string", "description": "Screen resolution of the customer's device, in pixels, with an `x` character as a delimiter", "example": "360x640" }, "session_id": { "type": "string", "description": "Identifier of the session cookie used by the customer" }, "language": { "type": "string", "description": "Customer’s language and country settings. May be used to personalise customer interface, notifications, and messages. The value is provided according to ISO 639-1 (language) and ISO 3166-1 alpha-2 (country) standards", "example": "en_US" }, "zip": { "type": "string", "maxLength": 10, "description": "Postal or zip code in the customer's address", "example": "75001" }, "address": { "type": "string", "description": "Name of the street and the house number (including any additional parts of the address such as building indicators and apartment numbers) in the address of the customer", "example": "Via Dietro Duomo 36" }, "district": { "type": "string", "maxLength": 255, "description": "District of the customer's address" }, "street": { "type": "string", "maxLength": 255, "description": "Name of the street in the customer's address", "example": "Breadmarket Street" }, "building": { "type": "string", "maxLength": 255, "description": "Building number in the customer’s address", "example": "4" }, "account_id": { "type": "string", "description": "Identifier of the customer's account in the external payment system" }, "gender": { "type": "string", "enum": [ "male", "female" ], "description": "Identifier of the customer's gender. Possible values: male or female" }, "qq_account_number": { "type": "string", "description": "Customer login in QQ social network" }, "ssn": { "type": "integer", "maxLength": 4, "description": "The last 4 digits of the customer's US social security number" }, "device_fingerprint": { "type": "string", "description": "Identifier generated based on a device's characteristics such as browser type, screen resolution, operating system, fonts, and others" }, "identify": { "type": "object", "description": "Object that contains customer identification document details", "properties": { "doc_number": { "type": "string", "maxLength": 255, "description": "Identifier of the document serving as a proof of identity for the customer", "example": "65432334567" }, "doc_type": { "type": "string", "maxLength": 255, "description": "Type of identification document" }, "doc_issue_date": { "type": "string", "maxLength": 255, "description": "Date when the identification document was issued. Used for identity verification", "example": "20.12.2012" }, "doc_issue_by": { "type": "string", "maxLength": 255, "description": "Name of the authority that issued the identification document. Can be used for identity verification", "example": "12346" }, "doc_issue_country": { "type": "string", "maxLength": 255, "description": "Name of the country where the identification document was issued. Can be used for identity verification" } } }, "billing": { "type": "object", "description": "Object contains customer billing address details", "properties": { "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Customer's country code in the ISO 3166-1 alpha-2 format", "example": "GB" }, "region": { "type": "string", "description": "Region or state of the customer's billing address" }, "region_code": { "type": "string", "pattern": "^[0-9A-Z]{1,3}$", "description": "The region or state code of the customer's billing address in ISO 3166-2 format" }, "city": { "type": "string", "maxLength": 256, "description": "Name of the place of residence (e.g., town, city, or other settlement type) in the customer's billing address", "example": "London" }, "address": { "type": "string", "maxLength": 512, "description": "Name of the street and the house number (including any additional parts of the address such as building indicators and apartment numbers) in the customer's billing address", "example": "Via Dietro Duomo 36" }, "postal": { "type": "string", "maxLength": 16, "description": "Postal code in the customer's billing address", "example": "BR1 1AA" }, "canadian_province": { "type": "string", "enum": [ "ON", "BC", "AB", "MB", "SK", "QC", "NS", "NB", "NF", "PE", "NT", "NU", "YT" ], "description": "Abbreviation of Canadian province" } } }, "citizenship": { "type": "string", "minLength": 1, "description": "Code of the sender's country of citizenship in ISO 3166-1 alpha-2" }, "accept_header": { "type": "string", "minLength": 1, "description": "Value of the HTTP Accept request header as received from the customer's browser" }, "color_depth": { "type": "integer", "description": "Colour depth of the screen as supported by the customer's browser, bits per pixel" }, "java_enabled": { "type": "boolean", "description": "Indicator specifying whether the customer's browser supports Java" }, "js_enabled": { "type": "boolean", "description": "Indicator specifying whether the customer's browser supports JavaScript" }, "timezone_offset": { "type": "string", "minLength": 1, "description": "Difference between the time in UTC (Coordinated Universal Time) and the local time of the browser, specified in minutes", "example": "-110" }, "timezone_name": { "type": "string", "description": "Name of the time zone the customer's browser is set to", "example": "Europe/London" }, "address_match": { "type": "boolean", "description": "Indicator specifying whether the customer's billing address matches the address specified in the shipping object. Possible values: `true`—addresses match, `false`—addresses do not match" }, "account": { "$ref": "#/components/schemas/AccountInfoAtMerchant" }, "shipping": { "$ref": "#/components/schemas/ShippingInfo" }, "shipping_extended": { "$ref": "#/components/schemas/ShippingExtendedInfo" }, "mpi_result": { "$ref": "#/components/schemas/MpiResult" }, "accept_language_header": { "type": "string", "minLength": 1, "description": "Indicates the preferred language(s) of the customer's browser, derived from the Accept-Language HTTP header, for example `en-GB,en;q=0.8,fr;q=0.3`" } }, "description": "Object that contains customer details without ip_address. Use CustomerInfo instead of this" }, "CustomerInfoBnplSale": { "description": "Object that contains customer details", "allOf": [ { "$ref": "#/components/schemas/CustomerInfoBase" }, { "type": "object", "properties": {}, "required": [ "id", "ip_address" ] } ] }, "CustomerInfoCard": { "type": "object", "description": "Object that contains customer details", "allOf": [ { "$ref": "#/components/schemas/CustomerInfo" }, { "type": "object", "properties": { "card_product_type": { "description": "Card product type: business or individual", "type": "string", "enum": [ "Business Card", "Individual Card" ] } }, "required": [ "id" ] } ] }, "CustomerInfoInvoice": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "maxLength": 255, "description": "Customer identifier unique within the project" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Customer's country code in the ISO 3166-1 alpha-2 format", "example": "GB" }, "city": { "type": "string", "maxLength": 256, "description": "Customer's address city name" }, "state": { "type": "string", "maxLength": 256, "description": "State" }, "phone": { "type": "string", "pattern": "^[0-9]{4,24}$", "description": "Customer's phone number, can be 4 to 24 digits long" }, "day_of_birth": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Customer's date of birth. This parameter is specified in DD-MM-YYYY format", "example": "12-12-1990" }, "birthplace": { "type": "string", "maxLength": 255, "description": "Customer's place of birth" }, "first_name": { "type": "string", "maxLength": 255, "description": "Customer first name" }, "middle_name": { "type": "string", "maxLength": 255, "description": "Customer's patronymic" }, "last_name": { "type": "string", "maxLength": 255, "description": "Customer last name" }, "email": { "type": "string", "maxLength": 255, "format": "email", "description": "Customer email" }, "language": { "type": "string", "description": "Customer’s language and country settings. May be used to personalise customer interface, notifications, and messages. The value is provided according to ISO 639-1 (language) and ISO 3166-1 alpha-2 (country) standards", "example": "en_US" }, "address": { "type": "string", "description": "Customer’saddress" }, "ssn": { "type": "integer", "maxLength": 4, "description": "The last 4 digits of the social security number of US." }, "billing": { "type": "object", "description": "Object contains billing address fields", "properties": { "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Customer's country code in the ISO 3166-1 alpha-2 format", "example": "GB" }, "region": { "type": "string", "description": "The region or state of the customer's billing address" }, "city": { "type": "string", "maxLength": 256, "description": "City of the billing customer address" }, "address": { "type": "string", "maxLength": 512, "description": "Street account address of the customer" }, "postal": { "type": "string", "maxLength": 16, "description": "Postal code of the billing address of the customer" } } }, "accept_language_header": { "type": "string", "minLength": 1, "description": "Indicates the preferred language(s) of the customer's browser, derived from the Accept-Language HTTP header, for example `en-GB,en;q=0.8,fr;q=0.3`" }, "account_id": { "type": "string", "description": "Customer identifier in external payment system that is used for payment performing" } }, "description": "Object that contains information about the customer" }, "CustomerInfoNameValidation": { "description": "Object that contains customer details for name validation", "allOf": [ { "$ref": "#/components/schemas/CustomerInfo" }, { "type": "object", "properties": { "name_validation": { "type": "boolean", "description": "Parameter that indicates name validation is required for the request" } } } ] }, "CustomerInfoPayout": { "allOf": [ { "$ref": "#/components/schemas/CustomerInfo" }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Customer identifier unique within the project" } }, "required": [ "id" ] } ] }, "CustomerInfoWalletRecurring": { "description": "Object that contains customer details for recurring payments performing by using e-wallets", "allOf": [ { "$ref": "#/components/schemas/CustomerInfo" }, { "type": "object", "required": [ "id" ] } ] }, "CustomerInfoWithId": { "description": "Object that contains customer details with mandatory identifier", "allOf": [ { "$ref": "#/components/schemas/CustomerInfo" }, { "type": "object", "required": [ "id" ] } ] }, "CryptoPayment": { "type": "object", "properties": { "cryptocurrency_type": { "type": "string", "enum": [ "cbdc", "stablecoins_fiat_backed", "native_tokens", "other" ], "description": "Indicator that specifies the type of the cryptocurrency, required for Mastercard and Visa payments involving cryptocurrencies" } } }, "Descriptor": { "type": "object", "properties": { "descriptor": { "type": "string", "maxLength": 255, "description": "also known as billing descriptor, which is the text identifying the merchant and providing additional information about the payment (for example, the customer identifier, phone number, location information, etc.). In case of card payments, the merchant descriptor is sent to the issuing bank and can be shown on the customer’s bank statement. It can also be utilised otherwise as per specifics of various payment methods." } } }, "ErrorItem": { "type": "object", "properties": { "code": { "type": "integer", "description": "Error code intended to represent the result of the operation processing", "example": 3287 }, "message": { "type": "string", "description": "Message intended to provide additional details clarifying the cause of the error", "example": "The payment currency is required" }, "field": { "type": "string", "description": "Name of the parameter that was erroneously specified (if such parameter is identified)" }, "constraint": { "type": "string", "description": "Information about the error. This information can be used to clarify the failure", "example": "required" } }, "description": "Object that contains single error information" }, "ErrorItems": { "type": "object", "properties": { "errors": { "type": "array", "description": "Array that contains information of one or more error messages", "items": { "$ref": "#/components/schemas/ErrorItem" } } }, "description": "Object that contains information of one or more error messages" }, "ErrorResponse": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string", "description": "Status of receiving of the request" }, "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Message that clarifies the cause of the error" } }, "description": "Object that contains information about request registration or processing error. Detailed information about the error see in the message parameter of the response" }, "ETokenInfoLight": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string", "description": "Token from payment system" } }, "description": "Information about token from payments system" }, "GateSuccessResponse": { "required": [ "payment_id", "project_id", "request_id", "status" ], "type": "object", "properties": { "status": { "type": "string", "maxLength": 255, "description": "Status indicating the result of the request acceptance" }, "request_id": { "type": "string", "maxLength": 100, "description": "Identifier of the request specified by the payment platform" }, "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123 }, "payment_id": { "type": "string", "maxLength": 255, "description": "Identifier of the payment that uniquely identifies a payment within the project. This identifier is case-insensitive: identifiers such as `order_314` and `Order_314` are considered identical. The identifier can include any letters, digits, and symbols in UTF-8 encoding, except when certain characters appear at the beginning or at the end of the string. These characters include a space, a horizontal tab, a null byte, a vertical tab, a newline/line feed, and a carriage return", "example": "payment_443" } }, "description": "Object that contains information about request acceptance or execution in the payment platform" }, "GeneralInfo": { "type": "object", "description": "Object that contains general request details", "required": [ "project_id", "payment_id", "signature" ], "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "payment_id": { "type": "string", "minLength": 1, "maxLength": 255, "strict": true, "description": "Identifier of the payment that uniquely identifies a payment within the project. This identifier is case-insensitive: identifiers such as `order_314` and `Order_314` are considered identical. The identifier can include any letters, digits, and symbols in UTF-8 encoding, except when certain characters appear at the beginning or at the end of the string. These characters include a space, a horizontal tab, a null byte, a vertical tab, a newline/line feed, and a carriage return", "example": "payment_443" }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" }, "merchant_callback_url": { "type": "string", "minLength": 1, "maxLength": 255, "description": "URL for handling request callbacks. This parameter should be passed when callbacks for a request need to be sent to an address that is different from that specified by default (for information about callbacks and how to use them, see [Handling callbacks](https://developers.ecommpay.com/en/en_platform_callbacks.html))", "example": "https://cosmoshop.earth/specialorder" } } }, "GeneralInfoInvoice": { "required": [ "payment_id", "project_id", "signature" ], "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "payment_id": { "type": "string", "minLength": 1, "maxLength": 255, "strict": true, "description": "Identifier of the payment that uniquely identifies a payment within the project. This identifier is case-insensitive: identifiers such as `order_314` and `Order_314` are considered identical. The identifier can include any letters, digits, and symbols in UTF-8 encoding, except when certain characters appear at the beginning or at the end of the string. These characters include a space, a horizontal tab, a null byte, a vertical tab, a newline/line feed, and a carriage return", "example": "payment_443" }, "merchant_callback_url": { "type": "string", "minLength": 1, "maxLength": 255, "description": "URL for handling request callbacks. This parameter should be passed when callbacks for a request need to be sent to an address that is different from that specified by default (for information about callbacks and how to use them, see [Handling callbacks](https://developers.ecommpay.com/en/en_platform_callbacks.html))", "example": "https://cosmoshop.earth/specialorder" }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } }, "description": "Object that contains parameters for generating and submitting a payment link purchase to the payment platform" }, "GeneralInfoClarification": { "type": "object", "description": "Object that contains general request details", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "payment_id": { "type": "string", "minLength": 1, "maxLength": 255, "strict": true, "description": "Identifier of the payment that uniquely identifies a payment within the project. This identifier is case-insensitive: identifiers such as `order_314` and `Order_314` are considered identical. The identifier can include any letters, digits, and symbols in UTF-8 encoding, except when certain characters appear at the beginning or at the end of the string. These characters include a space, a horizontal tab, a null byte, a vertical tab, a newline/line feed, and a carriage return", "example": "payment_443" }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } }, "required": [ "project_id", "payment_id", "signature" ] }, "GeneralInfo3DS": { "type": "object", "description": "Object that contains general request details", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "payment_id": { "type": "string", "minLength": 1, "maxLength": 255, "strict": true, "description": "Identifier of the payment that uniquely identifies a payment within the project. This identifier is case-insensitive: identifiers such as `order_314` and `Order_314` are considered identical. The identifier can include any letters, digits, and symbols in UTF-8 encoding, except when certain characters appear at the beginning or at the end of the string. These characters include a space, a horizontal tab, a null byte, a vertical tab, a newline/line feed, and a carriage return", "example": "payment_443" }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } }, "required": [ "project_id", "payment_id", "signature" ] }, "GiftCardInfo": { "type": "object", "properties": { "amount": { "type": "integer", "description": "Payment amount in minor units of currency" }, "currency": { "type": "string", "maxLength": 3, "description": "Currency code in ISO 4217 alpha-3 format" }, "count": { "type": "integer", "maximum": 99, "description": "Number of gift cards" } }, "description": "Object that contains information about gift card" }, "GooglePayETokenInfoLight": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string", "description": "Token from the Google Pay service" }, "google_gateway_type": { "type": "string", "description": "GooglePay gateway type. Possible values: `gateway`—the payment data is processed by Ecommpay's acquiring system, `merchant`—the payment data is processed through a third-party payment system" }, "google_tokenization_type": { "type": "string", "description": "GooglePay tokenisation type. Possible values: `DIRECT`—decryption of the Google Pay response on third-party servers, `PAYMENT_GATEWAY`—decryption of the Google Pay response on the Ecommpay side as the payment gateway" }, "google_gateway_id": { "type": "string", "description": "Identifier of the gateway. This parameter is assigned by Google Pay" }, "google_merchant_id": { "type": "string", "description": "Identifier of the merchant. This parameter is assigned by Google Pay" }, "google_gateway": { "type": "string", "description": "Payment gateway in Google Pay, for example `ecommpay` for Ecommpay" }, "google_transaction_id": { "type": "string", "description": "Identifier of the Google Pay payment" } }, "description": "Information about token from payments system" }, "Installment": { "type": "object", "properties": { "ext_plan_id": { "type": "string", "description": "Installment plan ID assigned by VIS" }, "count": { "type": "integer", "description": "Number of installment periods" }, "frequency": { "type": "string", "enum": [ "A", "B", "C", "M", "Q", "S", "T", "W", "2" ], "description": "Payment frequency" }, "terms_and_conditions": { "type": "object", "description": "Terms and conditions of the contract", "properties": { "language": { "type": "string", "description": "Customer’s language and country settings. May be used to personalise customer interface, notifications, and messages. The value is provided according to ISO 639-1 (language) and ISO 3166-1 alpha-2 (country) standards", "example": "en_US" }, "version": { "type": "number", "description": "Version" } } } } }, "KlarnaAdditional": { "type": "object", "description": "Additional information block", "properties": { "klarna_network_session_token": { "type": "string", "description": "Klarna session network token" }, "klarna_network_data": { "type": "string", "description": "Klarna network data" }, "integration_metadata": { "type": "object", "description": "Data for transmitting the integration context to the payment system", "properties": { "originators": { "type": "array", "description": "Information about the merchant modules involved in the request", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the platform providing data passed towards Klarna in the request." }, "module_name": { "type": "string", "description": "The name of the software module providing the data passed in the request to Klarna." }, "module_version": { "type": "string", "description": "A parameter indicating the version of the integration indicated by the module_name parameter." }, "session_reference": { "type": "string", "description": "A parameter containing a long-lived, unique identifier assigned by the application associated with an overall transaction or session." } } } }, "integrator": { "type": "object", "description": "Acquirer data involved in the request", "properties": { "name": { "type": "string", "description": "The name of the integrator sending the request to Klarna." }, "module_name": { "type": "string", "description": "The name of the software module providing the data passed in the request to Klarna" }, "module_version": { "type": "string", "description": "An optional parameter indicating the version of the integration indicated by the module_name parameter" }, "session_reference": { "type": "string", "description": "A parameter containing a long-lived, unique identifier assigned by the application associated with an overall transaction or session." } } } } } } }, "MerchantAuthGeneralInfo": { "required": [ "payment_id", "project_id", "signature", "type" ], "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "payment_id": { "type": "string", "minLength": 1, "maxLength": 255, "strict": true, "description": "Identifier of the payment that uniquely identifies a payment within the project. This identifier is case-insensitive: identifiers such as `order_314` and `Order_314` are considered identical. The identifier can include any letters, digits, and symbols in UTF-8 encoding, except when certain characters appear at the beginning or at the end of the string. These characters include a space, a horizontal tab, a null byte, a vertical tab, a newline/line feed, and a carriage return", "example": "payment_443" }, "type": { "type": "string", "enum": [ "start", "finish" ], "description": "Type of merchant auth request" }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } }, "description": "Object that contains required details of the merchant auth request (customer authentication by the payment system on merchant's request)" }, "MerchantInfo": { "type": "object", "properties": { "descriptor": { "type": "string", "pattern": "^[^!@&~№{}|<>\\[\\]]*$", "maxLength": 255, "description": "also known as billing descriptor, which is the text identifying the merchant and providing additional information about the payment (for example, the customer identifier, phone number, location information, etc.). In case of card payments, the merchant descriptor is sent to the issuing bank and is shown on the customer’s bank statement. It can also be utilised otherwise as per specifics of various payment methods." }, "data": { "type": "string", "minLength": 1, "description": "Information about the payment provided by the merchant. Can include details about the purchased items or services (number, description, SKU, etc.) or any other relevant data. This information is not sent to the payment provider or other third parties and is used at the merchant’s discretion" } }, "description": "Object that contains additional information provided by the merchant" }, "MotoInfo": { "type": "object", "description": "Object that contains payment details including MO/TO type", "properties": { "moto_type": { "type": "integer", "default": 0, "enum": [ 0, 1, 2 ], "description": "Type of a Mail Order/telephone Order purchase determined by the way the cardholder provides the card details (phone, mail, fax, or email). Possible values: `0`—not a MO/TO payment, `1`—Mail Order payment, `2`—Telephone Order payment" } } }, "MpiResult": { "type": "object", "properties": { "acs_operation_id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "description": "Operation identifier in ACS" }, "authentication_flow": { "type": "string", "pattern": "^0[1-2]$", "description": "The indicator of the flow that was used for the customer 3-D Secure 2 authentication within the previous operation" }, "authentication_timestamp": { "type": "string", "pattern": "^\\d{12}$", "description": "Date and time of the previous successful customer authentication as returned in the `mpi_timestamp` parameter of the callback with payment processing result. Format: A numeric string containing exactly 12 digits with no spaces, letters, or special characters" } }, "description": "An object that contains information about previous mpi result" }, "OperationInfo": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the operation in the payment platform" }, "type": { "type": "string", "description": "Operation type" }, "status": { "type": "string", "description": "Operation status" }, "date": { "type": "string", "description": "Date and time when the operation status was most recently updated in the payment platform, in ISO 8601 format" }, "created_date": { "type": "string", "description": "Date and time when the operation was created in the payment platform in the format according to the ISO 8601 standart" }, "sum_initial": { "$ref": "#/components/schemas/Sum" }, "sum_converted": { "$ref": "#/components/schemas/Sum" }, "request_id": { "type": "string", "description": "Identifier of the request specified by the payment platform" }, "provider": { "$ref": "#/components/schemas/ProviderResultInfo" }, "code": { "type": "string", "description": "Operation processing result code" }, "message": { "type": "string", "description": "Operation processing result message" }, "eci": { "type": "string", "description": "Electronic Commerce Indicator, used for communicating whether the authentication was initiated and what was its outcome as well as whether the issuer or the merchant is responsible for approving payment processing and will take potential financial responsibility if a chargeback occurs. For more information, see [Electronic Commerce Indicators](https://developers.ecommpay.com/en/en_ECI_codes.html)" }, "operation_fee": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Operation fee amount in minor currency units", "example": 31 }, "currency": { "type": "string", "pattern": "^[:_A-Z0-9]{3,27}$", "description": "Currency code in the ISO-4217 alpha-3 format", "example": "USD" } } } }, "description": "Object that contains operation details" }, "PaymentBanksInfo": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0, "maximum": 10000000000000, "description": "Payment amount in minor units of currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment currency code in the ISO 4217 alpha-3 format" }, "customer_amount": { "type": "integer", "minimum": 0, "maximum": 10000000000000, "description": "Payment amount converted into the currency selected by the customer. This parameter is specified in minor units of currency" }, "description": { "type": "string", "maxLength": 255, "description": "Payment description or comment for additional data analisys by using Dashboard" }, "extra_param": { "type": "string", "maxLength": 255, "description": "Parameter for passing additional settings for customise the payment processing flow" }, "best_before": { "type": "string", "format": "date-time", "description": "Payment expiration date in the date-time format according to the ISO 8601 standart" }, "challenge_indicator": { "type": "string", "pattern": "^0[1-9]$", "description": "Indicates whether the challenge flow is preferred. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "challenge_window": { "type": "string", "pattern": "^0[1-5]$", "description": "The dimensions of a window in which the authentication page opens. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "reorder": { "type": "string", "pattern": "^0[1-2]$", "description": "Indicates whether the customer is buying the merchandise or the service for the first time or it is a repeat purchase. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "preorder_purchase": { "type": "string", "pattern": "^0[1-2]$", "description": "Parameter specifying whether the current purchase is pre-ordered. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "preorder_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Date when the preordered merchandise or service will be available in the DD-MM-YYYY format" }, "gift_card": { "$ref": "#/components/schemas/GiftCardInfo" }, "local_conversion_currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Conversion currency code, provided in ISO 4217 alpha-3 format" }, "details": { "type": "object", "description": "Object that contains customer identification document details", "properties": { "document_number": { "type": "string", "description": "Number of the identification document used for verification" }, "document_date": { "type": "string", "description": " Date when the relevant contract or document was concluded" } } }, "device_channel": { "type": "string", "pattern": "^0[1-3]$", "description": "Indicator that specifies the type of the interface through which the web service initiates the 3-D Secure authentication. By default, it is set to `02` (Browser-based). In specific cases that must be agreed upon and approved, the value of this parameter can be `01` (App-based) and `03` (3DS Requestor Initiated). If `01` or `03` value is passed when it was not initially agreed upon, the payment may get declined" } }, "description": "Object that contains payment details" }, "PaymentInfo": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Payment amount in minor units of currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment currency code in ISO-4217 alpha-3 format", "example": "USD" }, "customer_amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Payment amount converted into the currency selected by the customer. This parameter is specified in minor units of currency" }, "description": { "type": "string", "maxLength": 255, "description": "Description of the payment intended to provide additional context or comments" }, "end_to_end_id": { "type": "string", "maxLength": 35, "description": "Identifier provided by the SEPA payment initiator. This parameter is intended to be routed through the entire SEPA payment process" }, "extra_param": { "type": "string", "maxLength": 255, "description": "Parameter for passing additional settings for customise the payment processing flow" }, "best_before": { "type": "string", "format": "date-time", "description": "Payment link expiry date and time, in the ISO 8601 format" }, "challenge_indicator": { "type": "string", "pattern": "^0[1-9]$", "description": "Indicates whether the challenge flow is preferred. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "challenge_window": { "type": "string", "pattern": "^0[1-5]$", "description": "Dimensions of a window in which the authentication page opens. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "reorder": { "type": "string", "pattern": "^0[1-2]$", "description": "Indicates whether the customer is buying the merchandise or the service for the first time or it is a repeated purchase. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "preorder_purchase": { "type": "string", "pattern": "^0[1-2]$", "description": "Parameter specifying whether the current purchase is pre-ordered. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "preorder_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Date when the preordered merchandise or service will be available in the DD-MM-YYYY format" }, "gift_card": { "$ref": "#/components/schemas/GiftCardInfo" }, "local_conversion_currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment conversion currency code, provided in ISO 4217 alpha-3 format" }, "details": { "type": "object", "description": "Object intended to contain the customer's identification document details", "properties": { "document_number": { "type": "string", "description": "Number of the identification document used for verification" }, "document_date": { "type": "string", "description": "Date when the relevant contract or document was concluded" } } }, "device_channel": { "type": "string", "pattern": "^0[1-3]$", "description": "Indicator that specifies the type of the interface through which the web service initiates the 3-D Secure authentication. By default, it is set to `02` (Browser-based). In specific cases that must be agreed upon and approved, the value of this parameter can be `01` (App-based) and `03` (3DS Requestor Initiated). If `01` or `03` value is passed when it was not initially agreed upon, the payment may get declined" }, "is_fast": { "type": "boolean", "description": "Indicator specifying whether the payment is processed using a fast payment method" } }, "description": "Object that contains payment details" }, "PaymentInfoDirectDebit": { "required": [ "currency" ], "type": "object", "properties": { "amount": { "type": "integer", "maximum": 10000000000000, "description": "Payment amount in minor units of currency" }, "currency": { "type": "string", "pattern": "^[:_A-Z0-9]{3,27}$", "description": "Payment currency in the ISO 4217 alpha-3 format" }, "customer_amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Payment amount converted into the currency selected by the customer. This parameter is specified in minor units of currency" }, "description": { "type": "string", "maxLength": 255, "description": "Textual comment or description of the payment, can be used for additional data analysis and reporting in Dashboard" }, "end_to_end_id": { "type": "string", "maxLength": 35, "description": "SEPA identifier (provided by initiating SEPA transaction end-customer), routed through the whole payment process." }, "extra_param": { "type": "string", "maxLength": 255, "description": "Parameter for passing additional settings for customise the payment processing flow" }, "best_before": { "type": "string", "format": "date-time", "description": "Payment expiration date in the date-time format according to the ISO 8601 standart" }, "challenge_indicator": { "type": "string", "pattern": "^0[1-9]$", "description": "Indicates whether the challenge flow is preferred. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "challenge_window": { "type": "string", "pattern": "^0[1-5]$", "description": "The dimensions of a window in which the authentication page opens. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "reorder": { "type": "string", "pattern": "^0[1-2]$", "description": "Indicates whether the customer is buying the merchandise or the service for the first time or it is a repeat purchase. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "preorder_purchase": { "type": "string", "pattern": "^0[1-2]$", "description": "Parameter specifying whether the current purchase is pre-ordered. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "preorder_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Date when the preordered merchandise or service will be available in the DD-MM-YYYY format" }, "gift_card": { "$ref": "#/components/schemas/GiftCardInfo" }, "local_conversion_currency": { "type": "string", "pattern": "^[:_A-Z0-9]{3,27}$", "description": "Payment conversion currency code, provided in ISO 4217 alpha-3 format" }, "details": { "type": "object", "description": "Object intended to contain customer identification document details", "properties": { "document_number": { "type": "string", "description": "Number of the identification document that can be used for verification" }, "document_date": { "type": "string", "description": "Date when the relevant contract or document was concluded" } } }, "device_channel": { "type": "string", "pattern": "^0[1-3]$", "description": "Indicator that specifies the type of the interface through which the web service initiates the 3-D Secure authentication. By default, it is set to `02` (Browser-based). In specific cases that must be agreed upon and approved, the value of this parameter can be `01` (App-based) and `03` (3DS Requestor Initiated). If `01` or `03` value is passed when it was not initially agreed upon, the payment may get declined" }, "is_fast": { "type": "boolean", "description": "Indicator intended to show whether the payment is processed using a fast payment method" } } }, "PaymentInfoForCard": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfoWMoTo" }, { "$ref": "#/components/schemas/CryptoPayment" }, { "type": "object", "description": "Object that contains payment details for card", "properties": { "debt_account": { "type": "string", "maxLength": 10, "description": "The number of the account designated to receive funds as part of the debt settlement purchases", "example": "an9876170i" }, "allow_partial_approval": { "type": "boolean", "description": "Parameter that indicates whether the merchant accepts partial approval for this purchase" } } } ] }, "PaymentInfoInvoice": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfoInvoiceByToken" }, { "type": "object", "properties": { "force_method": { "type": "string", "maxLength": 255, "description": "Identifier of the payment method intended to be opened by default, without the option for the customer to select a different payment method. For complete list of payment methods codes, see [Payment method codes](https://developers.ecommpay.com/en/en_pm_codes.html)" } } } ] }, "PaymentInfoInvoiceByToken": { "required": [ "amount", "best_before", "currency" ], "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Payment amount in minor units of currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment currency code in ISO 4217 alpha-3 format" }, "description": { "type": "string", "maxLength": 255, "description": "Payment description" }, "extra_param": { "type": "string", "maxLength": 255, "description": "Parameter for passing additional settings for customise the payment processing flow" }, "best_before": { "type": "string", "format": "date-time", "description": "Date and time of payment expiration. Keep in mind that the validity period of the payment link cannot exceed 30 days" }, "moto_type": { "type": "integer", "default": 0, "enum": [ 0, 1, 2 ], "description": "Type of a Mail Order/Telephone Order purchase determined by the way the cardholder provides the card details (phone, mail, fax, or email). Possible values: `0`—not a MO/TO payment, `1`—Mail Order payment, `2`—Telephone Order payment" } }, "description": "Object which contains payment information for invoice by token" }, "PaymentInfoRecurring": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Payment amount in minor units of currency" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment currency code in the ISO 4217 alpha-3 format", "example": "USD" }, "description": { "type": "string", "maxLength": 255, "description": "Payment description or comment for additional data analisys by using Dashboard" }, "extra_param": { "type": "string", "maxLength": 255, "description": "Parameter for passing additional settings for customise the payment processing flow" }, "challenge_indicator": { "type": "string", "pattern": "^0[1-9]$", "description": "Indicates whether the challenge flow is preferred. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "challenge_window": { "type": "string", "pattern": "^0[1-5]$", "description": "The dimensions of a window in which the authentication page opens. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "reorder": { "type": "string", "pattern": "^0[1-2]$", "description": "Indicates whether the customer is buying the merchandise or the service for the first time or it is a repeated purchase. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "preorder_purchase": { "type": "string", "pattern": "^0[1-2]$", "description": "Parameter specifying whether the current purchase is pre-ordered. For more information, see [3‑D Secure authentication](https://developers.ecommpay.com/en/en_gate_payment_3ds.html)", "example": "01" }, "preorder_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Date when the preordered merchandise or service will be available in the DD-MM-YYYY format" }, "gift_card": { "$ref": "#/components/schemas/GiftCardInfo" }, "local_conversion_currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Payment currency code in the ISO 4217 alpha-3 format" }, "details": { "type": "object", "description": "Object that contains customer identification document details", "properties": { "document_number": { "type": "string", "description": "Number of the identification document used for verification" }, "document_date": { "type": "string", "description": "Date when the relevant contract or document was concluded" } } }, "device_channel": { "type": "string", "pattern": "^0[1-3]$", "description": "Indicator that specifies the type of the interface through which the web service initiates the 3-D Secure authentication. By default, it is set to `02` (Browser-based). In specific cases that must be agreed upon and approved, the value of this parameter can be `01` (App-based) and `03` (3DS Requestor Initiated). If `01` or `03` value is passed when it was not initially agreed upon, the payment may get declined" } }, "description": "Object that contains payment details" }, "PaymentInfoWMoTo": { "allOf": [ { "$ref": "#/components/schemas/PaymentInfo" }, { "type": "object", "description": "Object that contains payment details including MO/TO type", "properties": { "moto_type": { "type": "integer", "default": 0, "enum": [ 0, 1, 2 ], "description": "Type of a Mail Order/telephone Order purchase determined by the way the cardholder provides the card details (phone, mail, fax, or email). Possible values: `0`—not a MO/TO payment, `1`—Mail Order payment, `2`—Telephone Order payment" } } } ] }, "PaymentStatusResponse": { "required": [ "operations", "payment", "project_id", "signature" ], "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123 }, "payment": { "type": "object", "description": "Object that contains payment details", "properties": { "id": { "type": "string", "description": "Unique identification of the payment in the payment platform" }, "type": { "type": "string", "description": "Payment type" }, "status": { "type": "string", "description": "Payment status", "minLength": 1 }, "sum": { "$ref": "#/components/schemas/Sum" }, "date": { "type": "string", "description": "Date and time when the operation status was most recently updated in the payment platform, in ISO 8601 format" }, "description": { "type": "string", "description": "Description of the payment passed in the initial request" }, "method": { "type": "string", "description": "Payment method that used to perform the payment" } }, "required": [ "status" ] }, "operations": { "type": "array", "description": "List of operations performed within the payment", "items": { "$ref": "#/components/schemas/OperationInfo" } }, "customer": { "$ref": "#/components/schemas/CustomerInfo" }, "recurring": { "type": "object", "description": "Object that contains recurring registration details of the payment. Details is submitted if the initial request for payment is passed with `recurring_registration=1` and the payment is successfully processed", "properties": { "id": { "type": "integer", "description": "Identifier of the created credential-on-file (COF) purchase. Can be used to perform and manage COF purchases" }, "currency": { "type": "string", "description": "Payment currency code in ISO 4217 alpha-3 format" }, "valid_thru": { "type": "string", "description": "Expiration date of the record about a series of funds debiting", "example": "2025-03-30 16:15:00" } } }, "account": { "type": "object", "description": "Object that contains customer's payment instrument (card, bank account, wallet, etc.) details", "properties": { "number": { "type": "string", "description": "Customer's account number", "example": "21312", "minLength": 1 }, "type": { "type": "string", "description": "Payment instrument type" }, "card_holder": { "type": "string", "description": "Name of the cardholder as specified on the payment card" }, "token": { "type": "string", "description": "Customer's card token identifier" }, "token_created_at": { "type": "string", "description": "Date and time of the token generation, specified in the ISO 8601 format with the UTC offset", "example": "2024-07-21T03:31:24+0000" } }, "required": [ "number" ] }, "acs": { "type": "object", "description": "Object that contains 3-D Secure data in case the card requires 3-D Secure authentication", "properties": { "pa_req": { "type": "string", "description": "Payer Authentication Request message received during the 3‑D Secure authentication", "minLength": 1 }, "md": { "type": "string", "description": "Merchant data received from a global card network during the 3‑D Secure authentication", "minLength": 1 }, "acs_url": { "type": "string", "description": "URL of the page to which the customer is redirected for the 3‑D Secure authentication (Access Control Server page)", "minLength": 1 } }, "required": [ "pa_req", "md", "acs_url" ] }, "errors": { "type": "array", "description": "Array of error messages", "items": { "$ref": "#/components/schemas/ErrorItem" } }, "signature": { "type": "string", "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)." } }, "description": "Object that contains the payment details passed to the request for payment status clarifying" }, "ProviderResultInfo": { "type": "object", "properties": { "id": { "type": "integer", "description": "Payment provider identifier in the payment platform", "example": 123 }, "payment_id": { "type": "string", "description": "Identifier of the payment that uniquely identifies a payment within the project. This identifier is case-insensitive: identifiers such as `order_314` and `Order_314` are considered identical. The identifier can include any letters, digits, and symbols in UTF-8 encoding, except when certain characters appear at the beginning or at the end of the string. These characters include a space, a horizontal tab, a null byte, a vertical tab, a newline/line feed, and a carriage return", "example": "payment_443" }, "auth_code": { "type": "string", "description": "Authorisation code received from a provider or a payment system", "example": "591748" }, "endpoint_id": { "type": "integer", "description": "Identifier of the payment gateway provided by the payment provider or system in CRC32 format", "example": 2 }, "result_code": { "type": "string", "description": "Result code provided by the payment provider or the payment system intended to indicate the result of the operation", "example": "00" }, "result_message": { "type": "string", "description": "Message with the result of operation. The parameter is provided by the payment provider or the payment system and offers additional details regarding the operation status and any related information", "example": "Success" }, "date": { "type": "string", "description": "Date and time when processing of the payment was completed on a provider or a payment system side", "example": "2022-02-22T19:52:14+0000" } }, "description": "Object containing information from the payment provider regarding the result of the operation" }, "PurchaseData": { "type": "object", "description": "Object that contains purchase data", "properties": { "positions": { "type": "array", "description": "Array of objects describing the order (purchase items)", "items": { "type": "object", "description": "Object that describe the order (purchase item)", "properties": { "type": { "type": "string", "description": "Order item type" }, "name": { "type": "string", "description": "Item name" }, "quantity": { "type": "integer", "description": "Quantity of items in the line item" }, "amount_total": { "type": "integer", "description": "Total amount for the line item" }, "tax_total": { "type": "integer", "description": "Total commission/tax amount" }, "amount": { "type": "integer", "description": "Item price" }, "product_url": { "type": "string", "description": "Link to the product description" }, "product_image": { "type": "string", "description": "URL to the product image" }, "product_reference": { "type": "string", "description": "Product identifier (product reference)" }, "item_reference": { "type": "string", "description": "Line item identifier (item ID in the list of items)" }, "shipping_reference": { "type": "string", "description": "Delivery identifier (reference in the deliveries array)" }, "booking_reference": { "type": "string", "description": "Reservation code" }, "departure": { "type": "object", "description": "Flight departure details", "properties": { "airport": { "type": "string", "description": "Departure airport" }, "date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Departure date in DD-MM-YYYY format" }, "address": { "type": "string", "description": "Departure address" }, "address2": { "type": "string", "description": "Extra departure address" }, "city": { "type": "string", "description": "Departure city" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Departure country (ISO 3166-1 alpha-2 code)" }, "postal": { "type": "string", "description": "Postal code of the place of departure" }, "region_code": { "type": "string", "pattern": "^[0-9A-Z]{1,3}$", "description": "The region or state of the customer address in ISO 3166-2 format." }, "location": { "type": "string", "description": "Place of departure" } } }, "arrival": { "type": "object", "description": "Arrival details", "properties": { "airport": { "type": "string", "description": "Arrival airport" }, "location": { "type": "string", "description": "Arrival location" }, "address": { "type": "string", "description": "Arrival address" }, "address2": { "type": "string", "description": "Extra arrival address" }, "city": { "type": "string", "description": "Arrival city" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Arrival country (ISO 3166-1 alpha-2 code)" }, "postal": { "type": "string", "description": "Postal code of the place of arrival" }, "region_code": { "type": "string", "pattern": "^[0-9A-Z]{1,3}$", "description": "The region or state of the customer address in ISO 3166-2 format." } } }, "airline": { "type": "string", "pattern": "^[A-Z0-9]{2}$", "description": "Airline" }, "price": { "type": "integer", "description": "Price" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Currency (ISO 4217 alpha-3 code)" }, "class": { "type": "string", "description": "Ticket class" }, "passengers": { "type": "array", "description": "Passengers", "items": { "type": "object", "description": "An object that contains passenger data", "properties": { "first_name": { "type": "string", "description": "Passenger first name" }, "last_name": { "type": "string", "description": "Passenger last name" } } } }, "insurances": { "type": "array", "description": "Insurances", "items": { "type": "object", "description": "An object that contains insurance company data", "properties": { "company": { "type": "string", "description": "Insurance company" }, "insurance_type": { "type": "string", "description": "Type of insurance" }, "amount": { "type": "integer", "description": "Cost of insurance" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Currency (ISO 4217 alpha-3 code)" } } } }, "affiliate": { "type": "string", "description": "Partner company providing the service" }, "car_rental_company": { "type": "string", "description": "Car rental company" }, "bus_company": { "type": "string", "description": "Bus company" }, "train_company": { "type": "string", "description": "Train company" }, "ferry_line": { "type": "string", "description": "Ferry transportation company" }, "hotel_name": { "type": "string", "description": "Hotel name" }, "start_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Check-in date (format: DD-MM-YYYY)" }, "end_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Check-out date (format: DD-MM-YYYY)" }, "address": { "type": "string", "description": "Address" }, "address2": { "type": "string", "description": "Extra address" }, "city": { "type": "string", "description": "City" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country (ISO 3166-1 alpha-2 code)" }, "postal": { "type": "string", "description": "Postal code" }, "region_code": { "type": "string", "pattern": "^[0-9A-Z]{1,3}$", "description": "The region or state of the customer address in ISO 3166-2 format." }, "lodging_type": { "type": "string", "description": "Hotel type" }, "rooms": { "type": "integer", "description": "Number of rooms to book" }, "guests": { "type": "array", "description": "List of guests", "items": { "type": "object", "description": "An object that contains guest data", "properties": { "first_name": { "type": "string", "description": "Guest first name" }, "last_name": { "type": "string", "description": "Guest last name" } } } }, "host": { "type": "object", "description": "Host(property owner) description", "properties": { "host_reference": { "type": "string", "description": "Unique host identifier used for booking platforms" }, "type": { "type": "string", "description": "Property type" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Host registration country (ISO 3166-1 alpha-2 code)" }, "registration_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Host registration date on the booking platform (format: DD-MM-YYYY)" }, "reservations": { "type": "integer", "description": "Number of reservations" } } }, "voucher_type": { "type": "string", "description": "Voucher type" }, "company": { "type": "string", "description": "Company providing products/services under the voucher" }, "insurance_type": { "type": "string", "description": "Insurance type" }, "event_type": { "type": "string", "description": "Event type" }, "venue_name": { "type": "string", "description": "Event location" }, "access_controlled": { "type": "boolean", "description": "Indicates if the tickets are digitally checked when entering the venue." }, "subscription_reference": { "type": "string", "description": "Subscription reference ID." }, "free_trial": { "type": "string", "description": "Trial period enabled." }, "billing_plans": { "type": "array", "description": "Array of subscription plans", "items": { "type": "object", "description": "An object that contains subscription plan data", "properties": { "amount": { "type": "integer", "description": "Charge amount" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Currency code in ISO 4217 alpha-3 format" }, "start_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Subscription start date (format: DD-MM-YYYY)" }, "interval": { "type": "string", "description": "Subscription interval" }, "frequency": { "type": "integer", "description": "Subscription frequency" } } } }, "amount_average": { "type": "integer", "description": "Average charge amount." }, "amount_min": { "type": "integer", "description": "Minimum charge amount." }, "amount_max": { "type": "integer", "description": "Maximum charge amount." }, "interval": { "type": "string", "description": "Billing interval." }, "frequency": { "type": "integer", "description": "Subscription frequency." }, "seller": { "type": "object", "description": "Marketplace seller", "properties": { "reference": { "type": "string", "description": "Seller reference ID" }, "name": { "type": "string", "description": "Seller name" }, "address": { "type": "string", "description": "Seller address line 1" }, "address2": { "type": "string", "description": "Seller address line 2" }, "postal": { "type": "string", "description": "Seller postal code" }, "city": { "type": "string", "description": "Seller city" }, "region_code": { "type": "string", "pattern": "^[0-9A-Z]{1,3}$", "description": "Seller state or province code (ISO 3166-2 subdivision code without country prefix)" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Seller country (ISO 3166-1 alpha-2 code)" }, "registration": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Seller registration date (format: DD-MM-YYYY)" }, "registration_updated": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Seller registration last updated date (ISO 8601 format: DD-MM-YYYY)" }, "last_login": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Seller last login date (ISO 8601 format: DD-MM-YYYY)" }, "rating": { "type": "string", "description": "Seller rating" } } }, "product_category": { "type": "string", "description": "Product category." }, "line_item_references": { "description": "References to line items for purchases with multiples subsellers associated.", "type": "array", "items": { "type": "string" } }, "shipping_references": { "type": "array", "items": { "type": "string" }, "description": "References to shipping addresses for purchases with multiples subsellers associated." }, "number_of_transactions": { "type": "integer", "description": "Number of transactions the sub-seller did in the last 12 months." }, "volume_of_transactions": { "type": "integer", "description": "Accumulated amount of sales transactions made by the sub-merchant or sub-seller within the past 12 months in the payment currency. Should be in minor currency units." } } } } }, "required": [ "positions" ] }, "PurchaseHistoryInfo": { "type": "array", "description": "Array of objects containing purchase history information.", "items": { "type": "object", "description": "Object that contains purchase history information", "properties": { "number_of_purchases": { "type": "integer", "description": "Number of purchase" }, "number_of_paid_purchases": { "type": "integer", "description": "Number of paid purchases" }, "number_of_disputed_purchases": { "type": "integer", "description": "Number of disputed purchases" }, "total_amount": { "type": "integer", "description": "Payment amount in minor units of currency" }, "currency": { "type": "string", "maxLength": 3, "pattern": "^[A-Z]{3}$", "description": "Currency payment. ISO 4217 alpha-3" }, "payment_method": { "type": "string", "description": "Payment method" }, "first_purchase_at": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}\\d{2}:\\d{2}$", "description": "Date and time of the first purchase in the format DD-MM-YYYYhh:mm" }, "last_purchase_at": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}\\d{2}:\\d{2}$", "description": "Date and time of the last purchase in the format DD-MM-YYYYhh:mm" } } } }, "ReceiptData": { "type": "object", "properties": { "positions": { "type": "array", "items": { "$ref": "#/components/schemas/ReceiptPositionData" }, "minItems": 1, "maxItems": 300 }, "total_tax_amount": { "type": "integer", "description": "Tax amount for a line item, specified in minor units of currency", "example": 1800 }, "common_tax": { "type": "number", "multipleOf": 0.01, "description": "Applicable tax rate, specified if it is the same for all line items in the order", "example": 18 } }, "description": "Object that contains the list of line items to be sent to the customer in the receipt once the payment is processed" }, "ReceiptPositionData": { "required": [ "amount" ], "type": "object", "properties": { "quantity": { "type": "number", "multipleOf": 0.000001, "description": "Quantity of the goods and services", "example": 3 }, "amount": { "type": "integer", "description": "Total cost for a particular line item. Calculated by multiplying the quantity of that item by its unit price. Specified in minor units of currency", "example": 10000 }, "tax": { "type": "number", "multipleOf": 0.01, "description": "Tax percentage applicable to the product or service", "example": 18 }, "tax_amount": { "type": "integer", "description": "Tax amount for a line item, specified in minor units of currency", "example": 1800 }, "description": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Description of a specific product or service being purchased", "example": "Photo frame" } }, "description": "Object that contains information about each line item in the purchase" }, "RecipientForCard": { "anyOf": [ { "required": [ "wallet_owner", "wallet_id" ], "type": "object", "description": "Object that contains the data of the payment recipient", "properties": { "wallet_owner": { "type": "string", "maxLength": 255, "description": "First and last name of the recipient who owns the digital wallet to which the funds will be credited", "example": "Fran Petrarca" }, "wallet_id": { "type": "string", "maxLength": 64, "pattern": "^[^!@&~№{}|<>\\[\\]]*$", "description": "Identifier of the digital wallet. Specified as is, without masked characters, spaces, or other separators", "example": "WID20071304" }, "card_holder": { "type": "string", "maxLength": 255, "description": "Name of the recipient (as specified on the card)" }, "country": { "maxLength": 2, "pattern": "^[A-Z]{2}$", "type": "string", "description": "Recipient's country code in the ISO 3166-1 alpha-2 format", "example": "GB" }, "address": { "maxLength": 99, "type": "string", "description": "Recipient address" }, "city": { "maxLength": 25, "type": "string", "description": "Name of recipient's address city" }, "state_code": { "maxLength": 3, "pattern": "^[A-Z]+$", "type": "string", "description": "State code of recipient" }, "day_of_birth": { "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "type": "string", "description": "Recipient's date of birth. This parameter is specified in DD-MM-YYYY format", "example": "12-12-1990" } } }, { "required": [ "card_holder", "pan" ], "type": "object", "description": "Object that contains the data of the transfer recipient", "properties": { "card_holder": { "type": "string", "maxLength": 255, "description": "Name of the cardholder as specified on the payment card" }, "pan": { "type": "string", "pattern": "^[0-9]{15,19}$", "description": "Number of the payment card used for payment. Specified as is, without masked characters, spaces, or other separators", "example": "4314220000000056" }, "country": { "maxLength": 2, "pattern": "^[A-Z]{2}$", "type": "string", "description": "Recipient's country code in the ISO 3166-1 alpha-2 format", "example": "GB" }, "address": { "maxLength": 99, "type": "string", "description": "Recipient address" }, "city": { "maxLength": 25, "type": "string", "description": "Namr of recipient's address city" }, "state_code": { "maxLength": 3, "pattern": "^[A-Z]+$", "type": "string", "description": "State code of recipient" }, "day_of_birth": { "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "type": "string", "description": "Recipient's date of birth. This parameter is specified in DD-MM-YYYY format", "example": "12-12-1990" } } } ] }, "RecurringIdInfo": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Unique identifier of the recurring payment in the payment platform" } }, "description": "Object that contains Identifier of the created credential-on-file (COF) purchase. Can be used to perform and manage COF purchasesentifier" }, "RecurringInfo": { "type": "object", "properties": { "type": { "type": "string", "pattern": "^[RCU]$", "description": "Payment type" }, "expiry_year": { "type": "integer", "minimum": 2020, "maximum": 9999, "description": "Year of expiration for credential-on-file (COF) payment. Can be used to define the last year when COF payment are allowed. If this parameter is not passed in the request, the payment platform will use the default values (for detailed information, refer to the documentation portal)" }, "expiry_month": { "type": "integer", "minimum": 1, "maximum": 12, "description": "Month of expiration for credential-on-file (COF) payment. Can be used together with `expiry_year` to set the final period of recurring payment validity. If this parameter is not passed in the request, the payment platform will use the default values (for detailed information, refer to the documentation portal)" }, "expiry_day": { "type": "integer", "minimum": 1, "maximum": 31, "description": "Day of expiration for credential-on-file (COF) payment. Can be used together with `expiry_month` and `expiry_year` to specify the exact expiration date. If this parameter is not passed in the request, the payment platform will use the default values (for detailed information, refer to the documentation portal)" }, "interval": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Interval of performing regular purchases. This parameter should be assigned a numeric value from `1` to `100` (for example, each three weeks) and is necessarily used in conjunction with the **period** parameter. May be used to configure payment recurrence frequency" }, "amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Amount of payment in minor currency units" }, "period": { "type": "string", "pattern": "^[DWMQY]$", "description": "Frequency interval of recurring debit operations executed within a credential-on-file (COF) payment. Possible values: `D`—Day, `W`—Week, `M`—Month, `Q`—Quarter, `Y`—Year" }, "time": { "type": "string", "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$", "description": "Time of performing subsequent debits (for a regular purchase) in the hh:mm:ss format. The parameter may be used if the **period** parameter is specified in the request" }, "register": { "type": "boolean", "description": "Indicator that defines whether the payment should be registered as credential-on-file. Is assigned to the true value to register credential-on-file payment" }, "scheduled_payment_id": { "type": "string", "maxLength": 255, "description": "Identifier assigned to the payment (as **payment_id**) within which scheduled debits are performed; it must differ from the identifier of the payment made to register a credential-on-file purchase and must be unique within the project. This identifier is case-insensitive: identifiers such as `order_314` and `Order_314` are considered identical. The identifier can include any letters, digits, and symbols in UTF-8 encoding, except when certain characters appear at the beginning or at the end of the string. These characters include a space, a horizontal tab, a null byte, a vertical tab, a newline/line feed, and a carriage return", "example": "A2323" }, "start_date": { "type": "string", "maxLength": 19, "pattern": "^([0-3]\\d-){2}[1-2]\\d{3}$", "description": "First automatic payment date and time in DD-MM-YYYY format. Obligatory when `scheduled_payment_id` is set. Applicable only when **recurring.type = R** and **recurring.period** is set. Is used to authorize and perform the next recurring payment. **start_date** can't be less than the response date of the initial *sale/auth* request within which the recurring was registered" } }, "description": "Object that contains recurring payment details and conditions" }, "RecurringInfoSuccess": { "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123 }, "recurring": { "type": "object", "description": "Object that contains information about the credential-on-file (COF) purchase. For more information, see [Credential-on-file (COF) purchases](https://developers.ecommpay.com/en/en_Gate__payments_on_saved_data.html)", "properties": { "id": { "type": "integer", "description": "Identifier of the created credential-on-file (COF) purchase. Can be used to perform and manage COF purchases" }, "type": { "type": "string", "description": "Indicator of the credential-on-file purchase type", "example": "R" }, "period": { "type": "string", "description": "Frequency interval of recurring debit operations executed within a credential-on-file (COF) payment. Possible values: `D`—Day, `W`—Week, `M`—Month, `Q`—Quarter, `Y`—Year" }, "period_interval": { "type": "string", "description": "Multiplicator to increase debiting period, for example to run debiting every third week, `period` should be set to `W` and `interval` should be set to `3`. Possible values: from `1` to `100`", "example": "3" }, "start_date": { "type": "string", "description": "Date to perform the first debit in the yyyy-mm-dd format." }, "start_time": { "type": "string", "description": "Time of subsequent debiting in the HH:mm format" }, "amount": { "type": "string", "description": "Debit amount in minor units of currency" }, "currency": { "type": "string", "description": "Currency code in ISO-4217 alpha-3 format" }, "payment_method": { "type": "string", "description": "Code of the payment method that was used to make the payment to register a COF purchase (according to [the reference table](https://developers.ecommpay.com/en/en_pm_codes.html), with relevant codes listed in the Gate, Dashboard column)" }, "last_payment_at": { "type": "string", "description": "The date when the last debit was made", "example": "2025-03-30 16:15:00" }, "valid_thru": { "type": "string", "description": "Expiration date of the record about a series of funds debiting" }, "status": { "type": "string", "description": "Indicator of the current state of the debiting series record created after a successful COF purchase registration", "example": "active" }, "description": { "type": "string", "description": "Description of the credential-on-file purchase", "maxLength": 255 }, "schedule_date": { "type": "object", "properties": { "next": { "type": "string", "description": "Next scheduled payment date in the YYYY-MM-DD hh-mm-ss format" }, "last": { "type": "string", "description": "Last scheduled payment date in the YYYY-MM-DD hh-mm-ss format" } } } } }, "retry_info": { "type": "object", "description": "Object that contains information about the credential-on-file purchase retry attempts", "properties": { "trigger_operation_id": { "type": "integer", "description": "Identifier of the debit operation that is being retried" }, "next_retry_exists": { "type": "boolean", "description": "Indicator that shows whether the next scheduled attempt is available. Possible values: `true`—specified when the debiting resulted in decline and there is an available retry attempt (the number of attempts and the time allocated for making them are not used up); `false`—in all other cases" }, "next_retry_date": { "type": "string", "description": "Scheduled date and time of the next retry attempt", "example": "2023-05-24T16:58:02+0000" } } } }, "description": "Object that contains general information about the credential-on-file purchase" }, "RecurringRequiredInfo": { "allOf": [ { "$ref": "#/components/schemas/RecurringInfo" }, { "required": [ "type" ] } ] }, "RecurringUpdateInfo": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Identifier of the created credential-on-file (COF) purchase. Can be used to perform and manage COF purchases" }, "expiry_year": { "type": "integer", "minimum": 2020, "maximum": 9999, "description": "Year of expiration for credential-on-file (COF) payment. Can be used to define the last year when COF payment are allowed" }, "expiry_month": { "type": "integer", "minimum": 1, "maximum": 12, "description": "Month of expiration for credential-on-file (COF) payment. Can be used together with expiry_year to set the final period of recurring payment validity" }, "expiry_day": { "type": "integer", "minimum": 1, "maximum": 31, "description": "Day of expiration for credential-on-file (COF) payment. Can be used together with expiry_month and expiry_year to specify the exact expiration date" }, "interval": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Interval of performing regular purchases. This parameter should be assigned a numeric value from `1` to `100` (for example, each three weeks) and is necessarily used in conjunction with the **period** parameter. May be used to configure payment recurrence frequency" }, "amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Amount of payment in minor currency units" }, "period": { "type": "string", "pattern": "^[DWMQY]$", "description": "Frequency interval of recurring debit operations executed within a credential-on-file (COF) payment. Possible values: `D`—Day, `W`—Week, `M`—Month, `Q`—Quarter, `Y`—Year" }, "time": { "type": "string", "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$", "description": "Time of performing subsequent debits (for a regular purchase) in hh:mm:ss format. The parameter may be used if the **period** parameter is specified in the request" }, "scheduled_payment_id": { "type": "string", "maxLength": 255, "description": "Identifier assigned to the payment (as **payment_id**) within which scheduled debits are performed; it must differ from the identifier of the payment made to register a credential-on-file purchase and must be unique within the project. This identifier is case-insensitive: identifiers such as `order_314` and `Order_314` are considered identical. The identifier can include any letters, digits, and symbols in UTF-8 encoding, except when certain characters appear at the beginning or at the end of the string. These characters include a space, a horizontal tab, a null byte, a vertical tab, a newline/line feed, and a carriage return", "example": "A2323" }, "start_date": { "type": "string", "maxLength": 19, "pattern": "^([0-3]\\d-){2}[1-2]\\d{3}$", "description": "First automatic payment date and time in format **DD-MM-YYYY**. Obligatory when scheduled_payment_id is set. Applicable only when **recurring.type = R** and **recurring.period** is set. Is used to authorize and perform the next recurring payment. **start_date** can't be less than the response date of the initial *sale/auth* request within which the recurring was registered" }, "description": { "type": "string", "description": "Description for recurring", "maxLength": 255 } }, "description": "Object that contains updating recurring payment details" }, "RefundPaymentInfo": { "required": [ "description" ], "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Refund amount in minor currency units" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Currency code in ISO-4217 alpha-3 format" }, "description": { "type": "string", "maxLength": 255, "description": "Refund description or comment" }, "merchant_refund_id": { "type": "string", "maxLength": 255, "description": "Identifier of the refund for representing the refund operation within the merchant’s service" } }, "description": "Object that contains refund processing details" }, "ReturnUrl": { "type": "object", "properties": { "success": { "type": "string", "description": "URL for redirecting the customer to the merchant's web service after the payment is completed" }, "decline": { "type": "string", "description": "URL for redirecting the customer to the merchant's web service after the payment is declined" }, "return": { "type": "string", "description": "URL for redirecting the customer to the merchant's web service when the customer decides not to complete the payment" } }, "description": "Object that contains the URLs to which customer is redirected while or after payment performing" }, "SavedAccount": { "required": [ "id", "number" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Identifier of the payment instrument in the payment platform" }, "number": { "type": "string", "description": "Masked number or another identifier of the customer's payment instrument (for example, a payment card, an account, or a digital wallet)", "example": "424242***4243" }, "type": { "type": "string", "description": "Type of the saved payment instrument", "example": "card" }, "additional": { "type": "object", "description": "Object intended to contain supplementary details related to the payment instrument and customer", "properties": { "country": { "type": "string", "description": "Customer's country code in the ISO 3166-1 alpha-2 format", "example": "GB" }, "phone": { "type": "string", "description": "Customer's phone number, can be 4 to 24 digits long" }, "email": { "type": "string", "description": "Customer's email address" }, "card": { "type": "object", "description": "Card information", "properties": { "expiry": { "type": "string", "description": "Expiration date of the card intended to indicate the final valid month and year in the MM/YY format", "example": "02/24" }, "holder": { "type": "string", "description": "Name of the cardholder on the payment card" }, "type": { "type": "string", "description": "Payment card brand that was used in the processing of the payment, for example, Mastercard, Visa, and others" }, "country": { "type": "string", "description": "Customer's country code in the ISO 3166-1 alpha-2 format", "example": "GB", "pattern": "^[A-Z]{2}$" }, "product_name": { "type": "string", "description": "Name of the card product", "example": "PREPAID" }, "bank_name": { "type": "string", "description": "Name of the financial institution that issued the card", "example": "CITIGROUP" } } }, "recurring_enable": { "type": "boolean", "description": "Indicator showing whether credential-on-file purchase is created and active" } } }, "last_deposit_date": { "type": "string", "description": "Date indicating the most recent deposit operation using this payment instrument" }, "last_payout_date": { "type": "string", "description": "Date indicating the most recent payout operation using this payment instrument" }, "last_tokenize_date": { "type": "string", "description": "Date indicating when this payment instrument was most recently tokenized" }, "token": { "type": "string", "description": "Payment card token" }, "operation_type": { "type": "array", "description": "Indicator that specifies the type of the operation during which the payment instrument was saved. Example: `sale`" } }, "description": "Object that contains the customer's saved payment instrument details" }, "SenderInfo": { "type": "object", "properties": { "first_name": { "type": "string", "maxLength": 255, "description": "Sender's first name", "example": "Jane" }, "middle_name": { "type": "string", "maxLength": 255, "description": "Sender's middle, second, or patronymic name", "example": "Mary" }, "last_name": { "type": "string", "maxLength": 255, "description": "Sender's last name", "example": "Smith" }, "day_of_birth": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Sender's date of birth. This parameter is specified in DD-MM-YYYY format", "example": "12-12-1990" }, "birthplace": { "type": "string", "maxLength": 255, "description": "Name of the sender's birthplace (e.g., town, city, or other settlement type)", "example": "London" }, "phone": { "type": "string", "pattern": "^[0-9]{4,24}$", "description": "Sender's phone number, can be 4 to 24 digits long" }, "residence": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Code of the country in the sender's billing address, specified in ISO 3166-1 alpha-2" }, "citizenship": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Code of the sender's country of citizenship in ISO 3166-1 alpha-2" }, "person_type": { "type": "string", "description": "Type of the customer as a legal person, for example, a company or an individual, used for compliance" }, "account_number": { "type": "string", "maxLength": 255, "description": "Account number of the sender. Can be used for payment processing and compliance check" }, "payment_purpose": { "type": "string", "maxLength": 255, "description": "Declared purpose of the payment provided for anti-money laundering (AML) compliance checks." }, "source_of_income": { "type": "string", "maxLength": 255, "description": "Declared source of income of the sender used for anti-money laundering (AML) compliance" }, "beneficiary_relationship": { "type": "string", "maxLength": 255, "description": "Relationship between the sender and the recipient such as `employee` or `buyer`" }, "company_name": { "type": "string", "maxLength": 255, "description": "Sender legal entity name" }, "identify": { "type": "object", "description": "Object that contains sender's identification details", "properties": { "doc_number": { "type": "string", "maxLength": 255, "description": "Identity document number" }, "doc_type": { "type": "string", "maxLength": 255, "description": "Type of identity document" }, "doc_issue_date": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Date of issue of identity document" }, "doc_issue_by": { "type": "string", "maxLength": 255, "description": "Who issued the identity document" }, "doc_expiry_date": { "type": "string", "pattern": "^(0?[1-9]|[12][0-9]|3[01])\\.(0?[1-9]|1[0-2])\\.\\d{4}$", "description": "Date of expired identity document (format: DD.MM.YYYY)" } } }, "billing": { "type": "object", "description": "Object contains billing address fields", "properties": { "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country code of the sender's billing address in ISO 3166-1 alpha-2 format" }, "city": { "type": "string", "maxLength": 256, "description": "City of the billing sender address" }, "state": { "type": "string", "maxLength": 256, "description": "State of the sender address" }, "address": { "type": "string", "maxLength": 512, "description": "Street account address of the sender" }, "postal": { "type": "string", "maxLength": 16, "description": "Postal code of the billing address of the sender" } } }, "pan": { "type": "string", "maxLength": 32, "description": "Number of the payment card used for payment. Specified as is, without masked characters, spaces, or other separators", "example": "4314220000000056" }, "wallet_id": { "type": "string", "maxLength": 64, "pattern": "^[^!@&~№{}|<>\\[\\]]*$", "description": "Identifier of the digital wallet. Specified as is, without masked characters, spaces, or other separators", "example": "WID20071304" }, "address": { "maxLength": 255, "type": "string", "description": "Name of the street and the house number (including any additional parts of the address such as building indicators and apartment numbers) in the address of the payment sender", "example": "Via Certado 18" }, "zip": { "maxLength": 255, "type": "string", "description": "Sender's postal code", "example": "50142" }, "city": { "maxLength": 256, "type": "string", "description": "Name of the place of residence (e.g., town, city, or other settlement type) in the address of the payment sender", "example": "Florence" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Sender's country code in the ISO 3166-1 alpha-2 format", "example": "GB" }, "state": { "type": "string", "maxLength": 256, "description": "Sender's state" } }, "description": "Object that contains information about the sender" }, "SenderInfoPayout": { "allOf": [ { "$ref": "#/components/schemas/SenderInfo" }, { "$ref": "#/components/schemas/Descriptor" }, { "type": "object", "properties": { "funding_ips_id": { "type": "string", "maxLength": 50, "description": "Transaction ID from a preceding AFT" } } } ] }, "SenderInfoSale": { "allOf": [ { "$ref": "#/components/schemas/SenderInfo" }, { "$ref": "#/components/schemas/Descriptor" } ] }, "SessionGeneralInfo": { "required": [ "display_name", "domain_name", "project_id", "signature", "validation_url" ], "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" }, "validation_url": { "type": "string", "description": "URL received during the integration through Apple Pay JS API", "example": "https://apple-pay-gateway.apple.com/paymentservices/startSession" }, "domain_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Domain name of the merchant's web service", "example": "appay.eu.ngrok.io" }, "display_name": { "type": "string", "minLength": 1, "maxLength": 64, "description": "Name of the merchant store to display. This parameter is provided in UTF-8 encoding", "example": "Cosmoshop" } }, "description": "Object that contains parameters for initiating an Apple Pay session" }, "SessionResponse": { "required": [ "merchantSession" ], "type": "object", "properties": { "merchantSession": { "type": "object", "description": "Object that contains the merchant session information" } }, "description": "Object that contains Apple Pay session information" }, "ShippingExtendedInfo": { "type": "array", "description": "An array of objects that contains information about delivery", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Delivery type" }, "city": { "type": "string", "maxLength": 50, "description": "City from delivery address" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country from delivery address ISO 3166-1 alpha-2" }, "address": { "type": "string", "maxLength": 150, "description": "Street from delivery address" }, "address2": { "type": "string", "maxLength": 255, "description": "Additional address data" }, "postal": { "type": "string", "maxLength": 16, "description": "Index from delivery address" }, "region_code": { "type": "string", "pattern": "^[0-9A-Z]{1,3}$", "description": "The region or state of the customer billing address in ISO 3166-2 format. For example, CA in US or ON for Canada." }, "shipping_reference": { "type": "string", "maxLength": 255, "description": "Shipment Reference ID" }, "carrier": { "type": "string", "maxLength": 255, "description": "Shipping Carrier Name" }, "type_attributes": { "type": "array", "items": { "type": "string" }, "description": "Provide additional attributes describing services specific to the selected shipping method" }, "phone": { "type": "string", "pattern": "^[0-9]{4,24}$", "maxLength": 255, "description": "Recipient Phone Number" }, "email": { "type": "string", "maxLength": 255, "format": "email", "description": "Recipient Email Address" }, "last_name": { "type": "string", "maxLength": 255, "description": "Recipient Last Name" }, "first_name": { "type": "string", "maxLength": 255, "description": "Recipient First Name" } }, "description": "An object that contains information about delivery" } }, "ShippingInfo": { "type": "object", "properties": { "type": { "type": "string", "pattern": "^0[1-7]$", "description": "Delivery type" }, "delivery_time": { "type": "string", "pattern": "^0[1-4]$", "description": "Delivery time. Possible values: `01`—digital same day delivery, `02`—same day delivery, `03`—next day delivery, `04`—delivery more than one day after the purchase was made" }, "delivery_email": { "type": "string", "maxLength": 255, "description": "Email to deliver purchased digital content to if the customer chooses email delivery", "format": "email" }, "address_usage": { "type": "string", "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "description": "Date when the specified shipping address was used for the first time in DD-MM-YYYY format" }, "name_indicator": { "type": "string", "pattern": "^0[1-2]$", "description": "Indicator whether the customer's name matches the recipient's name. Possible values: `01`—names match, `02`—names do not match" }, "city": { "type": "string", "maxLength": 50, "description": "City from delivery address" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country code from delivery address in ISO 3166-1 alpha-2 format" }, "address": { "type": "string", "maxLength": 150, "description": "Street from delivery address" }, "postal": { "type": "string", "maxLength": 16, "description": "Index from delivery address" }, "address_usage_indicator": { "type": "string", "pattern": "^0[1-4]$", "description": "Indicator whether the shipping address used for this transaction was first used with the 3DS Requestor" }, "region_code": { "type": "string", "pattern": "^[0-9A-Z]{1,3}$", "description": "The region or state code of the customer shipping address in ISO 3166-2 format. For example, `CA` in US or `ON` for Canada" }, "region": { "type": "string", "maxLength": 255, "description": "The region or state of the customer's shipping address" } }, "description": "An object that contains information about delivery" }, "SkrillCustomerInfo": { "allOf": [ { "$ref": "#/components/schemas/CustomerInfo" }, { "type": "object", "properties": { "id": { "type": "string", "maxLength": 255, "description": "Customer identifier unique within the project" }, "subject": { "type": "string", "maxLength": 250, "description": "Subject line of the email notification sent to the customer" }, "note": { "type": "string", "maxLength": 2000, "description": "Textual comment included in the email notification sent to the customer. Can be used for providing additional information" } }, "required": [ "id" ] } ] }, "SourceInfo": { "type": "integer", "properties": { "id": { "type": "integer", "enum": [ 7 ], "description": "Interface type which is used for payment performing: 7 - Payment Page in iframe mode" }, "user": { "type": "string", "maxLength": 255, "format": "email", "description": "User's email from the source" } }, "required": [ "id" ] }, "StoredCardType": { "type": "integer", "minimum": 0, "maximum": 6, "description": "Indicator of a credential-on-file (COF) purchase type. Must be specified according to the [documentation](https://developers.ecommpay.com/en/en_Gate__payments_on_saved_data.html)" }, "Sum": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1, "maximum": 10000000000000, "description": "Amount in minor currency units" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Currency code in ISO 4217 alpha-3 format" } }, "description": "Object that contains the amount and currency" }, "TerminalInfo": { "type": "object", "properties": { "method_code": { "type": "string", "maxLength": 255, "description": "Payment method code from Payment Page" }, "mode_code": { "type": "string", "enum": [ "purchase", "card_tokenize", "card_verify" ], "description": "Payment Page mode" }, "name": { "type": "string", "enum": [ "v5", "embedded" ], "description": "Payment Page type" }, "cashout_data_timeout": { "type": "integer", "minimum": 0, "maximum": 99999, "description": "Cashout data timeout from terminal" }, "precheckout": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "description": "Precheckout page name" } } } }, "description": "Object that contains additional information from Payment Page" }, "TokenData": { "required": [ "token_type" ], "type": "object", "properties": { "token_type": { "type": "string", "enum": [ "network_token" ], "description": "Indicator specifying the type of the token" }, "cryptogram": { "type": "string", "minLength": 28, "maxLength": 28, "description": "Network token verification code, received when the token is collected from the card network" }, "eci": { "type": "string", "maxLength": 2, "enum": [ "01", "02", "05", "06", "07" ], "description": "The ECI that corresponds to the network token, received when the token is collected from the card network" }, "trid": { "type": "string", "minLength": 11, "maxLength": 11, "description": "Identifier of the merchant assigned when the merchant registers in the card network service for creating network tokens" } } }, "TokenizeCustomerInfo": { "description": "Object that contains the customer details", "allOf": [ { "$ref": "#/components/schemas/CustomerInfoBase" }, { "type": "object", "properties": { "project_id": { "type": "integer", "description": "Identifier of the project for managing the interactions of the web service with the payment platform. This identifier is assigned by Ecommpay during the integration", "example": 57123, "minimum": 1, "maximum": 4294967295 }, "signature": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Digital signature used for signing the request parameters. Should be generated using the appropriate algorithm after all relevant parameters have been specified. For more information, see [Signature generation and verification](https://developers.ecommpay.com/en/en_Gate_Authentication.html)" } }, "required": [ "project_id", "signature" ] } ] } } }, "tags": [ { "name": "Card payments" }, { "name": "Payment links" }, { "name": "Payment Page payouts" }, { "name": "Token operations" }, { "name": "Additional information submission" }, { "name": "Verification of Payee Service" }, { "name": "ADVCash" }, { "name": "Apple Pay" }, { "name": "ATM" }, { "name": "Bancontact" }, { "name": "Banks" }, { "name": "Bank Transfer" }, { "name": "Blik" }, { "name": "BNPL" }, { "name": "Cash in Kazakhstan" }, { "name": "China UnionPay" }, { "name": "Direct Debit" }, { "name": "EcoPayz" }, { "name": "Flutterwave" }, { "name": "Google Pay" }, { "name": "Interac E-Transfer" }, { "name": "Klarna" }, { "name": "M-Pesa" }, { "name": "Mobile" }, { "name": "Neosurf" }, { "name": "Neteller" }, { "name": "Online Banking" }, { "name": "Pix" }, { "name": "Skrill" }, { "name": "Turkey QR" }, { "name": "VietQR" }, { "name": "Wallet" }, { "name": "Requests for customer details" }, { "name": "Requests for information" }, { "name": "Requests for recurring" }, { "name": "Requests for refunding specific payments" } ] }