OperationItem

Operation details.

object
project_id
string

Project ID provided by ECommPay.

required
operation_id
string

Payment operation ID provided by ECommPay.

required
payment_id
string

Payment ID in the project.

required
operation_type
string

Operation type. One of the operation types supported by the ECommPay payment platform.

required
operation_status
string

Operation status. One of the operation statuses supported by the ECommPay payment platform.

required
account_number
string

ID of the payment instrument used by customer, for example, card number or wallet ID.

required
customer_ip
string

Customer IP address.

required
payment_method_name
string

Name of the payment method used for payment processing.

required
payment_method_type
string

Type of the payment method used for payment processing.

required
payment_description
string

Description of the payment as specified in the initial request.

required
operation_created_at
string

Date and time when the operation was created. Format: YYYY-MM-DD hh:mm:ss.

required
operation_completed_at
string

Date and time when the operation was completed in the payment platform. Format: YYYY-MM-DD hh:mm:ss.

provider_date
string

Date and time when the operation was completed on the payment provider side. Format: YYYY-MM-DD hh:mm:ss.

required
shipment_date
string

Date and time when the payment provider posted the operation for clearing. Format: YYYY-MM-DD hh:mm:ss.

required
sum_initial
object

Amount and currency code of the operation as specified in the initial request.

required
sum_converted
object

Code of the currency that the payment provider used for performing the operation and the initial amount converted to this currency.

required
arn
string

Acquirer Reference Number: a unique operation identifier in clearing exchange between banks or processing centers.

required
rrn
string

Reference Retrieval Number: a unique operation identifier assigned by the acquirer bank when the payment is initialized.

required
acquirer_bank_name
string

Name of the acquirer bank.

auth_code
string

Alphanumeric code which confirms that the card issuer / payment system approved processing of the payment. Authorization codes are not assigned to declined payments.

avs_post_code
string

Customer postal code for verification with the Address Verification Service. AVS applies to cardholders from the UK, USA, and Canada.

avs_result
string

A single-letter Address Verification Service response code sent by the issuer following the address verification. AVS applies to cardholders from the UK, USA, and Canada.

avs_street_address
string

Customer postal address for verification with the Address Verification Service. AVS applies to cardholders from the UK, USA, and Canada.

balance_id
string

ID of the merchant’s balance aggregation in the ECommPay payment platform under which all merchant accounts are aggregated. This ID is masked by adding id_mask to the initial identifier.

bank_name
string

Name of the issuer determined according to the BIN of the card.

bin
string

Bank Identification Number (first six to eight digits of PAN). Numeric identifier of the card organization member. Assigned separately to each card level (for example, Classic, Standard, Gold, Maestro, Visa Electron, etc.) offered by the issuing bank—a card organization member. Also referred to as IIN (Issuer Identification Number).

card_enroll_check
string

Specifies if the card supports 3-D Secure. Possible values are: E—Enrolled (the card supports 3DS), N—Not enrolled, U—Undefined (was unable to determine).

card_holder
string

The name of the cardholder (as specified on the card).

card_product_name
string

Name of the bank product determined according to the BIN of the card.

card_token
string

Token of the customer bank card in the ECommPay payment platform.

completed_refund
string

Amount of the issued refund in minor units of currency.

country_by_ip
string

Country determined according to the IP address of the customer (two-letter ISO country code).

country_by_bin
string

Country determined according to the BIN of the card, country of the card’s issuer (two-letter ISO code).

currency_rate
string

Currency exchange rate used for conversion of the payment amount from the source currency to the default currency.

customer_email
string

Customer email address.

customer_id
string

Identifier of the customer in the merchant’s project.

eci
string

Electronic commerce indicator. For possible velues and more information, see ECI codes.

expiration_date
string

Date indicating the validity period of the payment card.

legal_entity_name
string

Name of the merchant’s legal entity.

merchant_id
string

Identifier of the merchant within the payment platform.

payment_currency
string

Currency of the payment (currency in which payment_amount is specified). Must be the ISO 4217 alpha-3 currency code.

payment_type
string

ID of the payment type. Possible values are: 3—Sale, 31—Purchase_dms, 6—Recurring, 24—Transfer, 11—Payout.

project_name
string

Name of the merchant’s website (project).

project_url
string

URL of the merchant’s website (project).

provider_payment_id
string

dentifier of the operation assigned by the external payment system / provider.

recurring_id
string

ID of debiting series received in the callback with the COF purchase registration data. This ID is used for all debits performed as part of the COF purchase.

recurring_register
string

Specifies whether the recurring purchase was registered. Possible values are: 0—No. 1—Yes.

recurring_valid_thru
string

Specifies the date until which the COF purchase is valid.

remaining_refund
string

Reflects the remaining balance, only available for the operations which at certain point had success status.

secure_3ds_check
string

Specifies whether the customer was redirected to the ACS (Access Control Service) page where the password from the text message is entered. Possible values are: 0—Was not redirected. 1—Was redirected.

transaction_completed_at
string

Time of the payment completion.

transaction_created_at
string

Time of the payment creation.

transaction_status
string

Payment status.