Payture

https://payture.com/en/api
Admin
Payture API Documentation
Tokens:9,930
Snippets:39
Trust Score:9.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Generate Payture Payment Links Process

Source: https://payture.com/en/api/en/api/merchant-account

This service enables sellers to generate and send payment links to buyers. The process involves navigating to the 'Generate payment links' button in the Personal account, selecting the interface (InPay or eWallet), entering required parameters, and clicking 'Get link'. Payment links have a limited time for payment. Tracking of payment attempts is available in 'Sessions', and results are in 'Search' or 'Select' sections.

```APIDOC
Payment Link Generation Process:
  Step 1:
    Action: In the additional menu of Personal account, click on the "Generate payment links" button.
  Step 2:
    Action: Select the interface (InPay or eWallet), enter the required parameters and click "Get link".
    Note: The payment link will be generated in Personal account and sent to the buyer if necessary. If cheque generation is enabled for the terminal, it is necessary to fill in the cheque information. The cheque will be generated automatically after successful payment.
  Step 3:
    Action: Tracking of the buyer's payment attempts is available in Payture → "Sessions". After the first attempt, the payment results are available in Payture → "Search" or "Select" section.
```

--------------------------------

### Authorization Panel and Attempts Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Details the parameters available in the 'Authorization' panel when the system solution was 'Authorize', including authorization success, dates, and error codes. Also describes the parameters for authorization attempts if multiple attempts were made.

```APIDOC
Authorization Panel Parameters:
  Date:
    description: Date and time of payment.
  Amount:
    description: Transaction amount in payment currency.
  AF Authorization ID:
    description: Antifraud authorization identifier.
  Success:
    description: Authorization success flag.
  Result date:
    description: Date of authorisation result.
  Error code:
    description: Authorisation error code, if any.

Authorization Attempts Table (if multiple attempts):
  date:
    description: Date of the attempt.
  success:
    description: Success status of the attempt.
  error code:
    description: Error code if the attempt failed.
```

--------------------------------

### Payture API: Customer Search Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Outlines the parameters used to search for registered buyers, including merchant name, terminal, date, email, customer ID (VWUserLgn), phone number, and status.

```APIDOC
Parameter: Description
Merchant: Company name in the Payture system
Terminal: Name of the terminal to be selected Several terminals can be selected
Date: Value of date and time of payment
E-mail: Buyer's e-mail address
Customer: Buyer Identifier Corresponds to the VWUserLgn parameter in the eWallet API
Phone: Purchaser's telephone number Specified in international format (digits only, no spaces): [country code][operator code][subscriber number]
Status: Current status of Buyer profile All - Buyer profiles with any status Active - Buyer is registered and its profile is active Deleted - Buyer profile deleted
```

--------------------------------

### Payture AntiFraud Service Features

Source: https://payture.com/en/api/en/api/merchant-account

An overview of the key services provided by the Payture AntiFraud personal account. This includes functionalities for viewing statistics, searching transactions, testing fraud rules in a demo mode, and managing fraud rules for the seller.

```APIDOC
Analytics: Visual statistics of successful and rejected anti-fraud operations (in percentage and absolute values) for the selected period
Search/Selection: Search for transactions by the value of their parameters if they have passed the anti-frod monitoring check, as well as view transaction details, history and the result of the check.
Demo mode: Execution of the rules validity check in the anti-fraud system. Designed to perform the CheckFraud check from the Payture Anti-Fraud Personal Cabinet page
Rules management: View, create, delete or modify the fraud rules set for the Seller Access to to this service is not available to all sellers
```

--------------------------------

### API Parameters for eWallet Payment and Card Linking

Source: https://payture.com/en/api/en/api/merchant-account

This section describes the parameters for generating payment links and links to associate new cards with a Buyer's eWallet. Mandatory fields vary based on whether the operation is a 'Pay'/'Block' or 'Add' (card linking).

```APIDOC
eWallet Parameters:
  Terminal: Name of the Merchant's terminal through which the payment should be made or the card should be linked (Mandatory Pay or Block: Yes, Mandatory Add: Yes)
  Session type: Payment Type: Pay — single-stage payment Block — two-stage payment (Mandatory Pay or Block: Yes, Mandatory Add: N/A)
  User login: Buyer Identifier. This is equivalent to the VWUserLgn parameter in the eWallet API. If the user does not exist, a new user will be created with the given identifier (Mandatory Pay or Block: Yes, Mandatory Add: Yes)
  User password: Additional parameter of access to the buyer's private information (buyer's password). Corresponds to the VWUserPsw parameter in the eWallet API (Mandatory Pay or Block: Yes, Mandatory Add: Yes)
  Amount of payment: Transaction amount in payment currency (Mandatory Pay or Block: Yes, Mandatory Add: No)
  Visible amount: The amount displayed to the buyer on the payment page. This should be specified if the payment template has a placeholder {Total}. String, may contain delimiters or additional characters (Mandatory Pay or Block: No, Mandatory Add: No)
  Product name: The name of the product that will be displayed to the buyer on the payment page. This should be specified if the payment template has a placeholder {Product} (Mandatory Pay or Block: No, Mandatory Add: No)
  Order Id: Unique order number in the seller's system (Mandatory Pay or Block: Yes, Mandatory Add: No)
  Card ID: Card ID in the Payture system or FreePay value. The data of this card will be automatically substituted on the payment page. The Buyer will always be able to choose other cards from the wallet or pay with a new card. In case of FreePay, the data entry fields on the payment page will be empty (Mandatory Pay or Block: Yes, Mandatory Add: No)
  Phone number: Buyer's telephone number. Additional buyer information (Mandatory Pay or Block: No, Mandatory Add: No)
  Template tag: Name of the payment page template used. Used if the Seller applies multiple templates. If no parameter is specified, the default template is used (Mandatory Pay or Block: No, Mandatory Add: No)
  Template language: Language of the payment page template. Used when a single template is used in multiple languages. If no parameter is passed, the default template language is used (Mandatory Pay or Block: No, Mandatory Add: No)
  Additional fields: Additional transaction fields. Specified in the format: Title1=Value1;Title2=Value2;... (Mandatory Pay or Block: No, Mandatory Add: No)
  Send link: Buyer's email or phone number to which the payment link will be sent. Phone in the format 79995554444 (Mandatory Pay or Block: No, Mandatory Add: No)
```

--------------------------------

### Payture API: Payment Search Results Table Parameters

Source: https://payture.com/en/api/en/api/merchant-account

This section details the parameters displayed in the summary table of orders matching specified search criteria. It includes essential fields such as Date, Amount, Currency, and Status, along with various identifiers like Order Id and RRN, providing a quick overview of payment data returned by the Payture system's search functionality.

```APIDOC
Parameter: Description
Date: Value of date and time of payment
Last change: The last transaction made with a payment
Terminal: Name of the terminal in the Payture system
Amount: Transaction amount in payment currency
Currency: Three-digit payment currency code
Blocking amount: Amount of funds blocked on the purchaser's card
Status: Current payment status
Payment type: Select the payment method
ReasonCode: Reason for ChargeBack payment  The reason is specified by the seller in the personal locker when setting the payment status "ChargeBack"
RRN: Unique transaction identifier  Reference Retrieval Number
Error code: Error code received when the payment was unsuccessful
Card holder: Name and surname of the cardholder as entered by the user
Card mask: Masked card number in the format "123456xxxxxx1234".  The first 6 digits and the last 4 digits of the card number are mandatory. The symbols "x" should be used instead of the unknown digits of the card number
Order Id: Order number (payment identifier) from the payment request (corresponds to `OrderId`)
Merchant order ID: Order number assigned by the Payture system
User Id: Buyer ID in the seller's system  Present if passed by the seller in additional transaction parameters in the format CustomerId=Value
Template: Name of the template from which the payment was made
3DS: Whether 3-D Secure verification has been performed for this transaction
Auth code: Payment authorization code
Order Id to processing: Order number assigned at processing centre
IP: IP address from which the Buyer accessed the Seller's website and then to the payment page
Bank name: Name of card issuing bank
Custom field: Additional transaction field to perform an order search  Passed by the merchant in the CustomFields parameter of the request  The name of the optional parameter to perform an order search must be pre-configured by Payture Support
```

--------------------------------

### API Parameters for Report Generation

Source: https://payture.com/en/api/en/api/merchant-account

Describes the parameters available for generating reports within the Payture system, including customer, terminal, date, and options for including totals or errors.

```APIDOC
Parameters for Report Generation:
  Customer:
    Description: Name of the company in the Payture system
  Terminal:
    Description: Name of the seller's terminal in the gateway system Multiple terminals can be selected
  Date:
    Description: Period for which the report will be generated
  Include totals:
    Description: Adds to the report information about the total amount and number of transactions made during the specified time interval.
  Include errors:
    Description: Adds information to the report about errors received when making payments
  Only Terminals with turnover:
    Description: Only information on terminals with sales is included in the report. Terminals on which any operations were performed in the last 3 months
```

--------------------------------

### Payture Personal Cabinet Standard Transactions Overview

Source: https://payture.com/en/api/en/api/merchant-account

This section provides an overview of the standard transaction types available to merchants within the Payture personal account. It lists operations such as payment link generation, direct payment execution, full or partial unblocking of funds, charging, refunds, group transactions, refund confirmation letter creation, report generation, and Telegram Bot registration for analytics.

```APIDOC
Standard Transactions:
  Payment link generation:
    Description: Creation of a link, by clicking on which the Buyer will be able to make a payment
  Payment execution:
    Description: Payment by entering card details in the personal locker
  Cancel block:
    Description: Full unblocking of previously blocked funds
  Charge:
    Description: Partial or full release of previously blocked funds
  Refund:
    Description: Partial or full refund of debited funds
  Group transactions:
    Description: Unlock, charge or refund multiple orders
  Refund confirmation:
    Description: Creation of a refund confirmation letter
  Report generation:
    Description: Generation of payment report
  Telegram Bot Registration:
    Description: Connecting a bot to receive payment analytics in Telegram
```

--------------------------------

### Payture API: Transaction Details Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Describes the parameters available when viewing transaction details, including date, order number, session ID, terminal, session type, and amount.

```APIDOC
Parameter: Description
Date: Date and time of the first operation for this transaction
Order number: Transaction number in the seller's system
SessionId: Unique session identifier in the Payture system
Terminal: Name of the terminal in the Payture system
Session type: Type of operation
Amount: Transaction amount in payment currency
```

--------------------------------

### Transaction Details and Antifraud Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Describes the parameters displayed for a selected transaction, including payment details, IP information, antifraud terminal, order identifiers, amounts, card details, bank information, customer ID, and additional order parameters. Also covers parameters within the Antifraud Solution and Payment Result blocks.

```APIDOC
Transaction Details:
  Date:
    description: Date and time of payment
  IP:
    description: IP address from which the buyer accessed the seller's website and then the page where he entered his card details. Includes two-digit country code of the buyer's IP address, indicating the expected country of the buyer at the time of payment.
  AF Terminal:
    description: Name of the terminal in the antifraud system
  Merchant Order Id:
    description: Order number (payment identifier) from the payment request, corresponding to `OrderId`.
  Amount:
    description: Transaction amount in payment currency
  Card number:
    description: Masked card number (e.g., 123456xxxxxxx1234). Also displays information about blacklisted cards, including date added and method of addition.
  Bank:
    description: Name of the issuing bank of the card used for payment. Includes two-digit country code and city code of the card-issuing bank.
  Customer:
    description: User ID in the antifraud system
  Additional parameters:
    description: Additional parameters of the order provided by the seller in the payment request

Antifraud Solution Block:
  date:
    description: Date of the system solution.
  solution:
    description: The system's decision (e.g., "Authorize").
  Authorisation ID:
    description: Identifier if the solution was "Authorize".
  rule triggered:
    description: Name of the rule that was triggered.
  error code:
    description: Error code, if any.

Payment Result Block:
  date:
    description: Date of the payment.
  amount:
    description: Amount of the payment.
  successful:
    description: Flag indicating whether the payment was successful.
  3DS authorisation:
    description: Flag indicating whether the payment participated in 3DS authorisation.
```

--------------------------------

### Payture Payment Execution Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Defines the parameters required for executing a payment through the Payture service, allowing sellers to manually enter buyer card details. This service is recommended when the cardholder cannot pay independently.

```APIDOC
Parameter: Terminal
  Description: Name of the Seller's terminal through which the payment should be made
  Mandatory: Yes

Parameter: Order number
  Description: Unique order number (payment identifier)
  Mandatory: Yes

Parameter: Payment amount
  Description: Payment amount in roubles to the nearest 2 digits after the dot
  Mandatory: Yes

Parameter: Card number
  Description: Buyer's card number without spaces
  Mandatory: Yes

Parameter: Card holder
  Description: Name and surname of cardholder Latin letters or spaces only
  Mandatory: Yes

Parameter: Card validity period
  Description: Month and year of card validity
  Mandatory: Yes

Parameter: CVC2/CVV2
  Description: Card verification code
  Mandatory: Yes

Parameter: Customer
  Description: Additional buyer information
  Mandatory: No

Parameter: Additional parameters
  Description: Merchant can add one or more arbitrary parameters and their values
  Mandatory: No

Parameter: Cheque parameters
  Description: The format of cheque parameters corresponds to the parameters of a cheque without payment. Filling in the cheque parameters is mandatory if cheque generation is enabled
  Mandatory: No
```

--------------------------------

### Payture API: Detailed Payment Transaction Information Parameters

Source: https://payture.com/en/api/en/api/merchant-account

This section outlines the comprehensive parameters displayed for a selected payment transaction. It provides in-depth information including Terminal, Date, Order Id, Amount, Status, Card mask, and Transaction type, offering a complete view of individual payment details within the Payture system for detailed analysis.

```APIDOC
Parameter: Description
Terminal: Terminal name in the Payture system
Date: Date and time of payment
Last change: The last transaction made with a payment
Order Id: Order number (payment identifier) from the payment request (corresponds to `OrderId`)
Merchant order ID: Order number assigned by the Payture system
API type: Type of software interface used to make the payment
Amount: Transaction amount in payment currency
Currency: Three-digit payment currency code
Status: Current payment status
IP: IP address from which the Buyer accessed the Seller's website and then to the payment page
Bank name: Name of card issuing bank
Card type: Name of IPS and card product
Payment type: Selecting the type of payment
Card holder: Name and surname of the cardholder as entered by the user
Card mask: Masked card number in the format "123456xxxxxx1234".  The first 6 digits and the last 4 digits of the card number are mandatory. The symbols "x" should be used instead of the unknown digits of the card number
Transaction type: Indicates whether the transaction was OneStep or TwoStep
No CVV: Whether the transaction was carried out without entering the CVV
Description: Additional order description Transmitted by the Seller in the payment request
```

--------------------------------

### Process for Creating a Cheque Manually

Source: https://payture.com/en/api/en/api/merchant-account

This section outlines the step-by-step procedure for generating and sending a cheque to a buyer if it was not submitted with the original payment, using the Payture Personal Account interface.

```APIDOC
1. Go to the Payture tab → Analytics, click on the Cheque button.
2. Fill in the required fields and click 'Send'. The cheque will be transmitted to the online cash register service. The results can be found in the Cheques tab → Search or Selection.
```

--------------------------------

### Payture Cheque Creation API Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Defines the core parameters required for creating a cheque, including unique identifiers, terminal information, customer contact details, and message content for sending the cheque.

```APIDOC
Cheque Parameters:
- Parameter: Cheque Id
  Description: Unique cheque identifier in the seller's system (string, 1-64 characters)
- Parameter: Terminal
  Description: Name of the merchant's cheque generation terminal (selection available if more than one Terminal is registered with the Seller)
- Parameter: Group
  Description: Group of devices used to generate a cheque (string, 1-32 characters, default "main")
- Parameter: Type
  Description: Drop down list with payment type
- Parameter: CustomerContact
  Description: Phone number in +79995554444 format or Buyer's email to send the cheque (string, 1-32 characters) (tag: 1008)
- Parameter: Message
  Description: The subject of the email or SMS message string in which the cheque is sent to the purchaser (string, 1-50 characters, default "Payture cheque")
- Parameter: TemplateTag
  Description: Name of the cheque template used (required if the supplier has multiple cheque templates, default "Default")
- Parameter: TemplateLang
  Description: Language used in the cheque template (required if the seller has multiple cheque templates, default "Default" (russian))
```

--------------------------------

### API Parameters for InPay Payment Link Generation

Source: https://payture.com/en/api/en/api/merchant-account

This section details the mandatory and optional parameters required to successfully generate a payment link using the InPay API. All mandatory fields must be completed.

```APIDOC
InPay Parameters:
  Terminal: Name of the Seller's terminal through which the payment should be made (Mandatory: Yes)
  Session type: Payment Type: Pay — single-stage payment Block — two-stage payment (Mandatory: Yes)
  Order Id: Unique order number in the seller's system (Mandatory: Yes)
  Amount of payment: Transaction amount in payment currency (Mandatory: Yes)
  Visible amount: The amount displayed to the buyer on the payment page. This should be specified if the payment template has a placeholder {Total}. String, may contain delimiters or additional characters (Mandatory: No)
  Product name: The name of the product that will be shown to the Buyer on the payment page. It should be specified if the payment template has a placeholder {Product} (Mandatory: No)
  User return address: URL of the page the buyer is redirected to after a successful payment transaction (Mandatory: No)
  Template tag: Name of the payment page template used. Used if the Seller applies multiple templates. If no parameter is specified, the template named "Default" is used (Mandatory: No)
  Template language: Language of the payment page template. Used when a single template is used in multiple languages. If no parameter is passed, the "Default" template language is used (Mandatory: No)
  Additional fields: Additional fields of the transaction. Specified in the format: Title1=Value1;Title2=Value2;... (Mandatory: No)
  Send link: Email or phone number of the Buyer, where the payment link will be sent to. Phone in the format 79995554444 (Mandatory: No)
```

--------------------------------

### APIDOC: Payment Session Search Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Details the available parameters for searching payment sessions, including merchant and terminal names, date ranges, order IDs, session types, and customer/card information.

```APIDOC
Session Search Parameters:
  Merchant: Name of the company in the Payture system
  Terminal: Terminal name Several terminals can be selected
  Date: Value of date and time of payment
  Order Id: Order number (payment identifier) from the payment request (corresponds to the `OrderId`) Allows you to search for a payment
  Session type: Type of operation Pay — single stage payment Block — two-two-step payment Add — card binding
  Client: Customer ID Corresponds to the VWUserLgn parameter in the eWallet API
  Card number: Masked card number Contains the first 6 digits and the last 4 digits: 123456xxxxxxx1234
  Amount: Transaction amount in payment currency
  SessionId: Unique session identifier in the Payture system
```

--------------------------------

### Rules Tab Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Describes the parameters displayed in the 'Rules' tab, which shows the history of triggered rules and their impact on a transaction, including rule name, type, trigger status, weight, decision, and settings.

```APIDOC
Rules Tab Parameters:
  name:
    description: Name of the rule.
  type:
    description: Type of the rule.
  triggered:
    description: Flag indicating whether the rule was triggered.
  weight:
    description: Weight of the rule.
  decision:
    description: Decision of the rule on this transaction.
  settings:
    description: Settings of the rule.
```

--------------------------------

### APIDOC: Transaction Change History Fields

Source: https://payture.com/en/api/en/api/merchant-account

Describes the parameters and their descriptions found in the transaction change history table, providing insights into payment status, amounts, and card details.

```APIDOC
Transaction Change History Fields:
  Date: Value of date and time of payment
  Action: Payment status
  Amount: Transaction amount in payment currency
  Refunded amount: Refund amount
  Card number: Masked card number in the format "123456xxxxxx1234". The first 6 digits and the last 4 digits of the card number are mandatory. The symbols "x" should be used instead of the unknown digits of the card number
  Card holder: Name and surname of the cardholder as entered by the user
  Order Id to processing: Order number assigned at processing centre
```

--------------------------------

### Payture API: Customer Search Results Fields

Source: https://payture.com/en/api/en/api/merchant-account

Lists the fields displayed in the search results table for customers, such as registration date, terminal, customer ID, email, phone, and status.

```APIDOC
Parameter: Description
Date: Date and time of buyer registration
Terminal: Name of the terminal to which the buyer is bound
Customer: Buyer Identifier Corresponds to the VWUserLgn parameter in the eWallet API
E-mail: Buyer's e-mail address
Phone: Purchaser's telephone number
Status: Current status of Buyer profile All - Buyer profiles with any status Active - Buyer is registered and its profile is active Deleted - Buyer profile deleted
```

--------------------------------

### API Parameters for Cheque Selection

Source: https://payture.com/en/api/en/api/merchant-account

Outlines the parameters available for selecting a range of cheques, including Merchant, Terminal, Date, Status, Amount, ChequeDealAmount, Type, and CustomerContact.

```APIDOC
Parameters for Cheque Selection:
  Merchant:
    Description: Company name in the Payture system
  Terminal:
    Description: Name of the terminal used to create the cheque It is possible to select several Terminals
  Date:
    Description: The value of the date and time when the cheques were created
  Status:
    Description: Current cheque status (See: /api/#kassy-fz54_statuses_)
  Amount:
    Description: Cheque amount
  ChequeDealAmount:
    Description: Drop-down list with cheque attributes
  Type:
    Description: Drop-down list with cheque types
  CustomerContact:
    Description: Phone number in +79995554444 format or email of the Buyer to which the cheque was sent
```

--------------------------------

### APIDOC: Payment Session Search Results Fields

Source: https://payture.com/en/api/en/api/merchant-account

Outlines the fields displayed in the results table after a payment session search, covering payment dates, terminal details, session types, client and card information, and transaction specifics.

```APIDOC
Session Search Results Fields:
  Date: Date and time of payment Last change in payment
  Terminal: Name of the terminal in the Payture system
  Session type: Type of operation Pay — single stage payment Block — two-step payment Add — card binding
  Client: Customer ID Corresponds to the VWUserLgn parameter in the eWallet API
  Card number: Masked card number Contains the first 6 digits and the last 4 digits: 123456xxxxxxx1234
  Merchant Order Id: Order number (payment identifier) from the payment request (corresponds to `OrderId`)
  Amount: Transaction amount in payment currency
  Client: Customer ID Corresponds to the VWUserLgn parameter in the eWallet API
  Card ID: Unique card identifier in the Payture system
  Card number: Masked card number Contains the first 6 digits and the last 4 digits: 123456xxxxxxx1234
  Card holder: Name and surname of the cardholder as entered when the card was registered
  Card validity period: Month and year of card validity
  Confirmation code: Confirmation code When using SendCode
  Currency: Payment currency Three-digit payment currency code
```

--------------------------------

### Payture Cheque Product Item Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Specifies the parameters for individual product or service items included in a cheque, covering quantity, price, tax rates, payment methods, and product identification details.

```APIDOC
Product Parameters:
- Parameter: Quantity
  Description: Quantity (decimal number with an accuracy of 3 characters after the point) (tag: 1023)
- Parameter: Price
  Description: Cost per cheque item (decimal number to the nearest 2 digits after the full stop) (tag: 1079)
- Parameter: Tax
  Description: VAT Rate (tag: 1199)
- Parameter: PaymentMethodType
  Description: Drop-down list showing the calculation method (tag: 1214)
- Parameter: PaymentSubjectType
  Description: Drop-down list with the sign of the accounting object (tag: 1212)
- Parameter: Text
  Description: Name of the current item (name of the product, service, etc.) (string, 1-128 characters) (tag: 1030)
- Parameter: AdditionalAttribute
  Description: Additional requisite of the subject of settlement (string, 1-64 characters) (tag: 1191)
- Parameter: NomenclatureCode
  Description: Product Nomenclature Code (Base64 encoded array from 1 to 32 bytes) (tag: 1162)
- Parameter: SupplierINN
  Description: Supplier INN (string, 10-12 characters) (tag: 1226)
- Parameter: SupplierInfo-Name
  Description: Supplier name (tag: 1225)
- Parameter: SupplierInfo-phoneNumbers
  Description: Supplier phone numbers in the +799955544444 format (tag: 1171)
```

--------------------------------

### Process for Creating a Correction Cheque

Source: https://payture.com/en/api/en/api/merchant-account

This section describes the procedure for generating and sending a correction cheque through the Payture Personal Account, used when an existing cheque needs adjustment.

```APIDOC
1. Go to the "Payture" tab → "Analytics", click on the "Cheque" button.
2. Select "Correction Cheque", specify the required parameters and press "Send". The cheque will be sent to the Online Cashier service. The results can be found in the Cheques tab → Search or Selection.
```

--------------------------------

### Payture API: Transaction History Attempt Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Details the parameters available for viewing the history of payment attempts within a session, such as creation date, Payture order ID, last change date, success flag, 3DS preauthorization, 3DS status, and error code.

```APIDOC
Parameter: Description
Date of creation: Date and time of the transaction within the transaction
Payture order ID: Order number assigned to Payture Contains the sequence number of the attempt
Date: Date of last change
Success: Operation success flag
3DS Preauthorisation: Whether the buyer was redirected to the issuing bank's ACS page for 3DS authentication
3DS: Whether 3-D Secure verification has been performed for this transaction
Error code: Error code, in case of failure or error in transaction processing
```

--------------------------------

### Select Transactions by Multiple Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Enables filtering and sampling transactions by setting values for one or more available parameters. Parameters include Merchant, Terminal, Date, Chargeback date, Status, Type of payment, Error code, Amount, IP, User country, Bank name, Card holder, Card mask, 3DS, RRN, Custom field, Search field value, and IPS.

```APIDOC
Parameters:
  Merchant: Company name in the Payture system.
  Terminal: Name of the terminal to be selected. Several terminals can be selected.
  Date: Value of date and time of payment.
  Chargeback date: Chargeback settlement date. Date selection is available when ChargeBack is selected in the Status field.
  Status: Current payment status. Several statuses can be selected.
  Type of payment: Select the payment method. You can choose from several payment methods.
  Error code: Error code received when the payment was unsuccessful. It is possible to select several error codes.
  Amount: Transaction amount in payment currency.
  IP: IP address from which the Buyer accessed the Seller's website and then to the payment page.
  User country: Two-digit country code of the issuing bank of the card with which the payment was attempted.
  Bank name: Name of card issuing bank.
  User country: The two-digit country code of the country where the buyer is expected to be at the time of payment.
  Card holder: Name and surname of the cardholder as entered by the user. Latin letters or spaces. Please note that this is an ambiguous search parameter, as the buyer may mistype or deliberately change the characters entered.
  Card mask: Masked card number in the format "123456xxxxxx1234". The first 6 digits and the last 4 digits of the card number are mandatory. The symbols "x" should be used instead of the unknown digits of the card number.
  3DS: Whether 3-D Secure verification has been performed for this transaction.
  RRN: Reference Retrieval Number.
  Custom field: Additional transaction field to perform an order search. Passed by the merchant in the CustomFields parameter of the request. The name of the optional parameter to perform an order search must be pre-configured by Payture Support.
  Search field value: Field to search for orders by one or more additional transaction parameters. The parameters to be searched are provided by the merchant in additional parameters of the payment request. The names of additional parameters for order lookups must be agreed in advance with the Payture support team.
  IPS: International payment system that issued the card. It is possible to select multiple IPS.
```

--------------------------------

### Analytics Report Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Describes the various parameters available for filtering and detailing payment statistics in the analytics service, used for generating reports and insights.

```APIDOC
Analytics Parameters:
  Merchants:
    Description: Seller company (combines several terminals)
  Terminals:
    Description: Merchant terminals
  Card product type:
    Description: Card type Visa Classic, Mastercard Standard, Visa Gold etc.
  Bank country:
    Description: The country where the buyer is likely to be located at the time of payment
  User City:
    Description: Buyer's city as determined by buyer's IP address; the city where the buyer was likely to be at the time of payment
  Bank's country:
    Description: Two-digit country code of the issuing bank
  Currency:
    Description: Three digit payment currency code
  Banks:
    Description: Issuing bank of the card used for the attempted payment. Select a bank to see the top 10 card products for that bank
  Error code:
    Description: Error description for unsuccessful payments
  Detailing:
    Description: Detailed time report including selected parameters, displayed on the bottom graph
```

--------------------------------

### Payture Cards Search Results Parameters

Source: https://payture.com/en/api/en/api/merchant-account

This section outlines the detailed information provided in the search results table for buyer cards. The table includes data such as card binding date, terminal name, card ID, masked card number, validity period, cardholder name, customer ID, current card status, deletion date (if applicable), and CVV payment capability.

```APIDOC
Search Results Parameters:
  Date:
    Description: Date and time value of card binding
  Terminal:
    Description: Name of the terminal to which the card is bound
  Card ID:
    Description: Card ID in the Payture system
  Card number:
    Description: Masked card number in the format "123456xxxxxxxx7890" (First 6 digits and last 4 digits of the card number)
  Valid until:
    Description: Card validity period
  Card holder:
    Description: Name and surname of the cardholder as entered when the card was registered
  Customer:
    Description: Buyer's ID to which the card is linked
  Status:
    Description: Current status of the card
  Date of card deletion:
    Description: If the card has the status "Deleted"
  No CVV:
    Description: Indicates the ability to make a payment without entering CVV for this card.
```

--------------------------------

### Payture API: Customer Card Information Fields

Source: https://payture.com/en/api/en/api/merchant-account

Provides details on the fields available in the 'Cards' section of a customer's profile, including card addition date, card ID, masked card number, validity period, card holder name, and card status.

```APIDOC
Parameter: Description
Date: Date and time the card was added
Card ID: Card ID in the Payture system
Card number: Masked card number in the format "123456xxxxxxxx7890" First 6 digits and last 4 digits of the card number
Valid until: Card validity period
Card holder: Name and surname of the cardholder as entered when the card was registered
Status: Current status of the card Not Active — card is registered but not activated Not Active 3DS — the card is registered, but the Buyer has not passed 3DS authentication Is Active — the card is registered and activated Deleted — card removed
```

--------------------------------

### Payture Cheque Additional Provider Details Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Describes optional parameters for including supplementary details specific to the provider within the cheque documentation.

```APIDOC
Additional details for the provider Parameters:
- Parameter: CheckRequisite
  Description: Additional cheque details (tag: 1192)
- Parameter: AdditionalUserAttributeName
  Description: Name of additional user details (tag: 1085)
- Parameter: AdditionalUserAttributeValue
  Description: Value of additional user details (tag: 1086)
```

--------------------------------

### Payture Cards Search Parameters

Source: https://payture.com/en/api/en/api/merchant-account

This section details the parameters available for searching registered buyer cards within the Payture system. Users can filter cards by merchant, terminal, date, cardholder, masked card number, customer ID, and card status. The preferred search method involves using the Buyer's identifier and/or card mask.

```APIDOC
Search Parameters:
  Merchant:
    Description: Company name in the Payture system
  Terminal:
    Description: Name of the terminal to be selected. Several terminals can be selected
  Date:
    Description: Date and time value of card binding
  Card holder:
    Description: Name and surname of the cardholder entered by the Buyer. Latin letters or space. Please note that this is an ambiguous search parameter, as the Buyer may mistake the characters entered or deliberately change it
  Card number:
    Description: Masked card number in the format "123456xxxxxxxx7890" (First 6 digits and last 4 digits of the card number)
  Customer:
    Description: Buyer Identifier. Corresponds to the VWUserLgn parameter in the eWallet API
  Status:
    Description: Current status of the card.
      Not Active — card is registered but not activated
      Not Active 3DS — the card is registered, but the Buyer has not passed 3DS authentication
      Is Active — the card is registered and activated
      Deleted — card removed
```

--------------------------------

### Payture Cheque Payment Operator Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Details the parameters for providing information about the payment operator, such as their name, address, INN, and various contact phone numbers.

```APIDOC
Payment operator Parameters:
- Parameter: PaymentOperatorName
  Description: Payment operator name (tag: 1026)
- Parameter: PaymentOperatorAddress
  Description: Payment operator address (tag: 1005)
- Parameter: PaymentOperatorINN
  Description: Payment Operator INN (tag: 1016)
- Parameter: PaymentOperatorPhoneNumbers
  Description: Payment operator phone numbers in +79995554444 format (tag: 1074)
- Parameter: PaymentTransferOperatorPhoneNumbers
  Description: Payment transfer operator phone numbers in +79995554444 (tag: 1075)
```

--------------------------------

### Payture Correction Cheque API Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Details the mandatory parameters required when creating a correction cheque, emphasizing that all listed parameters are essential for successful generation.

```APIDOC
Correction check parameters (Attention! All parameters are mandatory!):
- Parameter: Id
  Description: Unique cheque identifier
```

--------------------------------

### Payture Cheque Payment Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Details the parameters for specifying payment types and their corresponding amounts within a cheque, with a critical note that the sum of all payment types must match the total of all items.

```APIDOC
Payment Parameters (Attention! The sum of all payment types must match the total of all items on the cheque.):
- Parameter: Type of payment
  Description: Drop down list with payment type
- Parameter: Amount
  Description: The amount of payment (decimal number to the nearest 2 decimal places)
```

--------------------------------

### API Parameters for Cheque Search

Source: https://payture.com/en/api/en/api/merchant-account

Details the unique parameters used to search for cheques in the Payture system, such as Merchant, Terminal, Cheque Id, Order ID, Payture Order ID, and Customer Contact.

```APIDOC
Parameters for Cheque Search:
  Merchant:
    Description: Company name in the Payture system
  Terminal:
    Description: Name of the terminal used to create the cheque It is possible to select several Terminals
  Cheque Id:
    Description: Unique cheque identifier
  Order ID:
    Description: Order number (payment identifier) from the payment request corresponds to `OrderId` Can be used if the cheque was generated together with the payment
  Payture Order ID:
    Description: The order number assigned by the Payture system Can be used if the cheque was generated together with the payment
  CustomerContact:
    Description: Phone number in +79995554444 format or email of the Buyer to which the cheque was sent
```

--------------------------------

### API Parameters for Cheque Search/Selection Results

Source: https://payture.com/en/api/en/api/merchant-account

Describes the parameters displayed in the results table after searching or selecting cheques, such as Date, Amount, Cheque type, Cheque Id, Payture Order ID, Order ID, Cheque status, Terminal, Currency, CustomerContact, and Payment status.

```APIDOC
Parameters for Cheque Search/Selection Results:
  Date:
    Description: The value of the date and time when the cheques were created
  Amount:
    Description: Cheque amount
  Cheque type:
    Description: Current cheque type
  Cheque Id:
    Description: Unique cheque identifier
  Payture Order ID:
    Description: The order number assigned by the Payture system
  Order ID:
    Description: Order number (payment identifier) from the payment request corresponds to `OrderId`
  Cheque status:
    Description: Current cheque statuses (See: /api/#kassy-fz54_statuses_)
  Terminal:
    Description: Name of the terminal to which the buyer is bound
  Currency:
    Description: Three digit cheque currency code
  CustomerContact:
    Description: Phone number in +79995554444 format or email of the Buyer to which the cheque was sent
  Payment status:
    Description: Current payment status Specified if
```

--------------------------------

### Payture Cheque Payment Agent Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Outlines the parameters for specifying information about the payment agent involved in the transaction, including their type and contact phone numbers.

```APIDOC
Payment agent Parameters:
- Parameter: AgentType
  Description: Agent Type (tag: 1057)
- Parameter: PaymentAgentOperation
  Description: Payment agent operation (tag: 1044)
- Parameter: PaymentAgentPhoneNumbers
  Description: Payment agent phone numbers in +79995554444 format (tag: 1073)
```

--------------------------------

### Cheque Correction Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Details the parameters required for a cheque correction operation, including identifiers, various sum types (cash, non-cash, prepayment, postpayment), and different taxation amounts and systems. Each parameter is described with its purpose and specific formatting requirements.

```APIDOC
Cheque identifier: Unique identifier for the cheque
Terminal: Name of payment Terminal Issued with test/production access parameters
Group: The group of devices that will be used to generate the cheque Default is "main"
CorrectionType: Correction Type (1173) "Independent" — if the correction is performed independently "By order" — if the correction is made by order of the supervisory authority
Type: Document type (1054)
Description: Description correction (1177) Reason for the correction and name of the document on which the correction is based
CauseDocumentDate: Date of the document grounds for correction (1178)
TotalSum: Amount of calculation specified in the cheque (1020) Decimal number with an accuracy of 2 characters after the point
CashSum: Amount of the cheque in cash (1031) Decimal number with an accuracy of 2 characters after the point
ECashSum: Amount of the cheque non-cash (1081) Decimal number with an accuracy of 2 characters after the point
PrepaymentSum: Amount of the cheque prepayment (offset advance and (or) previous payments) (1215) Decimal number with an accuracy of 2 characters after the point
PostpaymentSum: Amount of the cheque postpaid (on credit) (1216) Decimal number with an accuracy of 2 characters after the point
OtherPaymentTypeSum: Amount of the cheque counter provision (1217) Decimal number with an accuracy of 2 characters after the point
Tax1Sum: Amount of VAT cheque at the rate of 20% (1102) Decimal number with an accuracy of 2 characters after the point
Tax2Sum: Amount of VAT cheque at the rate of 10% (1103) Decimal number with an accuracy of 2 characters after the point
Tax3Sum: Amount of VAT cheque in rubles at the rate of 0%(1104) Decimal number with an accuracy of 2 characters after the point
Tax4Sum: Amount of calculation in rubles on the cheque without VAT (1105) Decimal number with an accuracy of 2 characters after the point
Tax5Sum: Amount of cheque VAT in roubles at the calculated rate of 20/120 (1106) Decimal number with an accuracy of 2 characters after the point
Tax6Sum: Amount of VAT cheque in rubles by calc. rate 10/110 (1107) Decimal number with an accuracy of 2 characters after the point
TaxationSystem: Taxation System (1055)
```

--------------------------------

### Search Transactions by Unique Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Allows searching for a transaction using specific unique identifiers. Preferred search parameters include Order Id, Card holder, Card mask, Merchant order ID, Order Id to processing, 3DS status, RRN, Custom field, and Search field value.

```APIDOC
Parameters:
  Order Id: Order number (payment identifier) from the payment request (corresponds to `OrderId`). Preferred search parameters.
  Card holder: Name and surname of the cardholder as entered by the user. Latin letters or spaces. Please note that this is an ambiguous search parameter, as the buyer may mistype or deliberately change the characters entered.
  Card mask: Masked card number in the format "123456xxxxxx1234". The first 6 digits and the last 4 digits of the card number are mandatory. The symbols "x" should be used instead of the unknown digits of the card number.
  Merchant order ID: Order number assigned by the Payture system.
  Order Id to processing: Order number assigned at processing centre.
  3DS: Whether 3-D Secure verification has been performed for this transaction.
  RRN: Reference Retrieval Number.
  Custom field: Additional transaction field to perform an order search. Passed by the merchant in the CustomFields parameter of the request. The name of the optional parameter to perform an order search must be pre-configured by Payture Support.
  Search field value: Field to search for orders by one or more additional transaction parameters. The parameters to be searched are provided by the merchant in additional parameters of the payment request. The names of additional parameters for order lookups must be agreed in advance with the Payture support team.
```

--------------------------------

### Payture Cheque Supplier Parameters

Source: https://payture.com/en/api/en/api/merchant-account

Specifies the parameters for providing contact information for the supplier associated with the cheque.

```APIDOC
Supplier Parameters:
- Parameter: SupplierPhoneNumbers
  Description: Supplier phone numbers in +79995554444 format (tag: 1171)
```
Tokens:
Raw