API Products of the Mir payment system

Dispute API documentation

Dispute case

Dispute Case

The dispute amount can't be more than the transaction amount for any selected reason.

Case Reason Goods or Services Not Received

Only an Issuer can initiate a dispute for the reason Goods or services not received and only over the following transaction types:

  • Purchase 
  • Quick Purchase
  • ECOM purchase
  • Purchase with Cash Back
Initiation form Code Data type Necessity Comments Default value

Request reason

f_RequestReason

RequestReason

Yes

 

ServiceNotPerformed

Dispute amount

f_DisputeAmount

Money

Yes

The dispute amount can’t be more than the purchase amount for the selected reason.
 

Transaction amount.
Note: For a Purchase with Cash Back transaction: Purchase amount.

Purchase Amount f_PurchaseAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  
Add Amount

f_AddAmount

Money   The field is not editable, used for the Purchase with Cash Back transaction.  

Purchase type

f_PurchaseType

PurchaseType

Yes

   

Purchase description

f_PurchaseDescription

PurchaseDescription

Yes

   

Expected delivery date

f_ExpectedDeliveryDate

Date

Yes, if Purchase type is Goods

   

Expected date of services / works delivery

f_ExpectedServiceDate

Date

Yes, if Purchase type is Service/Works

   

Documents

f_Docs

Files

     

Comments

f_Comment

Row

     

Clearing status

f_AdjClearingStatus

AdjClearingStatus

     


 Case Reason Unsuccessful Transaction

Only an Issuer can initiate a dispute for the reason Unsuccessful transaction and only over the following transaction types:

  • Purchase 
  • Quick Purchase
  • ECOM purchase
  • Funding
  • Purchase with Cash Back
Initiation form Code Data type Necessity Comments Default value
Request reason

f_RequestReason

RequestReason

Yes

 

FailOperation

Dispute amount

f_DisputeAmount

Money

Yes

For the "Purchase with Cash Back" transaction type, the dispute amount
must be equal to the transaction amount for the selected reason.

Transaction amount

Purchase Amount f_PurchaseAmount Money  

The field is not editable, used for the Purchase with Cash Back transaction.

 
Add Amount f_AddAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  

Documents

f_Docs

Files

     

Comments

f_Comment

Row

     

Clearing status

f_AdjClearingStatus

AdjClearingStatus

     


Case Reason Paid by Other Means

Only an Issuer can initiate a dispute for the reason Paid by other means and only over the following transaction types:

  • Purchase 
  • Quick Purchase
  • ECOM purchase
  • Purchase with Cash Back
Initiation form Code Data type Necessity Comments Default value

Reason of request

f_RequestReason

RequestReason

Yes

 

OtherPaymentMethod

Reason of request

f_RequestReason

RequestReason

Yes

 

OtherPaymentMethod

Dispute amount

f_DisputeAmount

Money

Yes

For the "Purchase with Cash Back" transaction type, the dispute amount must be equal to the transaction amount for the selected reason.

Transaction amount

Purchase Amount f_PurchaseAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  
Add Amount f_AddAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  

Payment method

f_PaymentMethod

PaymentMethod

Yes

 

BankCard

Payment transaction

f_PaymentTrx

Operation

Yes if Payment method is By Mir/ MC/Visa card

   

PAN

f_PaymentPan

Digits(13,19)

     

ARN

f_PaymentArn

Digits(23,23)

     

Amount

f_PaymentAmount

Money 

Yes if Payment method is By the card of another PS

   

Business date

f_PaymentDate

Date

Yes if Payment method is By the card of another PS

   

Check

f_PaymentCheck

Files

     

Payment description

f_CustomPayment

Row

Yes if Payment method is By other means

   

Documents

f_Docs

Files

     

Comments

f_Comment

Row

     

Clearing status

f_AdjClearingStatus

AdjClearingStatus

     


Case Reason Canceled Subscription

Only an Issuer can initiate a dispute for the reason Canceled subscription and only over the following transaction types:

  • Purchase 
  • Quick Purchase
  • ECOM purchase
  • Purchase with Cash Back
Initiation form Code Data type Necessity Comments Default value

Reason of request

f_RequestReason

RequestReason

Yes

 

SubscriptionCancelled

Dispute amount

f_DisputeAmount

Money

Yes

The dispute amount can’t be more than the purchase amount for the selected reason.

Transaction amount
Note: For a Purchase with Cash Back transaction: Purchase amount.

Purchase Amount f_PurchaseAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  
Add Amount f_AddAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  

Dispute justification

f_Justification

Row

Yes

   

Comments

f_Comment

Row

     

Documents

f_Docs

Files

     

Clearing status

f_AdjClearingStatus

AdjClearingStatus

     


Case Reason Defective Merchandise

Only an Issuer can initiate a dispute for the reason Defective merchandise and only over the following transaction types:

  • Purchase 
  • Quick Purchase
  • ECOM purchase
  • Purchase with Cash Back
Initiation form Code Data type Necessity Comments Default value

Reason of request

f_RequestReason

RequestReason

Yes

 

BadProduct

Dispute amount

f_DisputeAmount

Money

Yes

The dispute amount can’t be more than the purchase amount for the selected reason.

Transaction amount.
Note: For a Purchase with Cash Back transaction: Purchase amount.

Purchase Amount f_PurchaseAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  
Add Amount f_AddAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  

Dispute justification

f_Justification

Row

Yes

   

Comments

f_Comment

Row

     

Documents

f_Docs

Files

     

Clearing status

f_AdjClearingStatus

AdjClearingStatus

     


Case Reason Technical Error

Only an Issuer can initiate a dispute for the reason Technical error and only over the following transaction types: 

  • Purchase 
  • Quick Purchase
  • ECOM purchase
  • ATM withdrawal
  • Cash disbursement
  • Funding
  • Purchase with Cash Back
Initiation form Code Data type Necessity Comments Default value

Reason of request

f_RequestReason

RequestReason

Yes

 

TechError

Dispute amount

f_DisputeAmount

Money

Yes

For the "Purchase with Cash Back" transaction type, the dispute amount must be equal to the
transaction amount for the selected reason. 

Transaction amount

Purchase Amount f_PurchaseAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  
Add Amount f_AddAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  

Dispute justification

f_TechError_Justification

Row

Yes

   

Comments

f_Comment

Row

     

Documents

f_Docs

Files

     

Clearing status

f_AdjClearingStatus

AdjClearingStatus

     


Case Reason Non-receipt of Cash at ATM

Only an Issuer can initiate a dispute for the reason Non-receipt of cash at ATM and only over the following transaction types:

  • ATM withdrawal
  • Cash disbursement
  • Purchase with Cash Back
Initiation form Code Data type Necessity Comments Default value

Reason of request

f_RequestReason

RequestReason

Yes

 

NoCash

Dispute amount

f_DisputeAmount

Money

Yes

For the "Purchase with Cash Back" transaction type, the dispute amount must be equal to the transaction amount for the selected reason. 

Transaction amount.
Note: For a Purchase with Cash Back transaction: Purchase amount.

Purchase Amount f_PurchaseAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  
Add Amount f_AddAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  

Non-receipt type

f_NoCashType

NoCashType

Yes

   

Comments

f_Comment

Row

     

Documents

f_Docs

Files

     

Clearing status

f_AdjClearingStatus

AdjClearingStatus

     


Case Reason Non-receipt of P2P Transfer

Only an Acquirer can initiate a dispute for the reason Non-receipt of P2P transfer and only over the following transaction types:

  • Cash-to-Card
  • Card-to-Card
Initiation form Code Data type Necessity Default value

Reason of request

f_RequestReason

RequestReason

Yes

DestinatorNotCredited

Dispute amount

f_DisputeAmount

Money

Yes

Transaction amount

Comments

f_Comment

Row

   

Documents

f_Docs

Files

   


Case Reason Credit Not Received

Only an Acquirer can initiate a dispute for the reason Credit not received and only over the following transaction types:

  • Refund
Initiation form Code Data type Necessity Default value

Reason of request

f_RequestReason

RequestReason

Yes

RefundNotCredited

Dispute amount

f_DisputeAmount

Money

Yes

Transaction amount

Comments

f_Comment

Row

   

Documents

f_Docs

Files

   


Case Reason Request for Sender Information

Only an Issuer can initiate a dispute for the reason Request for sender information and only over the following transaction types:

  • Cash-to-Card
  • Card-to-Card
Initiation form Code Data type Necessity Default value

Reason of request

f_RequestReason

RequestReason

Yes

OriginatorInfo

Dispute amount

f_DisputeAmount

Money

Yes

Transaction amount

Comments

f_Comment

Row

   

Documents

f_Docs

Files

   

Clearing status

f_AdjClearingStatus

AdjClearingStatus

   


Case Reason Credit Not Processed

Only an Issuer can initiate a dispute for the reason Credit not processed and only over the following transaction types:

  • Purchase 
  • Quick Purchase
  • ECOM purchase
  • Purchase with Cash Back
Initiation form Code Data type Necessity Comments Default value

Reason of request

f_RequestReason

RequestReason

Yes

 

NoRefund

Date of purchase return / service cancellation

f_RefundDate

Date

Yes

   

Dispute amount

f_DisputeAmount

Money

Yes

The dispute amount can’t be more than the purchase amount for the selected reason. 

Transaction amount.
Note: For a Purchase with Cash Back transaction: Purchase amount.

Purchase Amount f_PurchaseAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  
Add Amount f_AddAmount Money   The field is not editable, used for the Purchase with Cash Back transaction.  

Comments

f_Comment

Row

     

Documents

f_Docs

Files

     

Clearing status

f_AdjClearingStatus

AdjClearingStatus

     


Case Reason Refusal of Credit

Only an Issuer can initiate a dispute for the reason Refusal of credit and only over the following transaction types:

  • Refund
  • Cash-to-Card
  • Card-to-Card
Initiation form Code Data type Necessity Default value

Reason of request

f_RequestReason

RequestReason

Yes

RefusalFromCredit

Reason for refusal of credit

f_RefusalReason

RefusalReason

Yes

 

Dispute amount

f_DisputeAmount

Money

Yes

Transaction amount

Comments

f_Comment

Row

   

Documents

f_Docs

Files

   

Clearing status

f_AdjClearingStatus

AdjClearingStatus

   


Case Reason Dynamic Currency Conversion

Only an Issuer can initiate a dispute for the reason Dynamic currency conversion and only over the following transaction types:

  • Purchase
  • ECOM purchase
  • ATM withdrawal
Initiation form Code Data type Necessity Default value

Reason of request

f_RequestReason

RequestReason

Yes

RefusalFromCredit

Dispute amount

f_DisputeAmount

Money

Yes

Transaction amount

Dispute justification

f_Justification

Row

Yes

 

Documents

f_Docs

Files

   

Comments

f_Comment

Row

   

Clearing status

f_AdjClearingStatus

AdjClearingStatus

   

 

Case Reason Cash not credited


Only an Issuer can initiate a dispute for the reason Cash not credited and only over the following transaction types:

  • Card Status Inquiry

Initiation form Code Data type Necessity Default value

Reason of request

f_RequestReason

RequestReason

Yes

CashNotCredited

Dispute amount

f_DisputeAmount

Money

Yes

 

Documents

f_Docs

Files

   

Comments

f_Comment

Row

 

 

 

Case Reason Incorrect operation amount

Only an Issuer can initiate a dispute for the reason Incorrect operation amount and only over the following transaction types:

  • Purchase

  • Quick purchase

  • Purchase ECOM

Initiation form Code Data type Necessity Comments Default value

Reason of request

f_RequestReason

RequestReason

Yes

 

IncorrectAmount

Dispute amount

f_DisputeAmount

Money

Yes The dispute amount must be less than the transaction amount

 

Dispute justification f_Justification Row Yes    

Documents

f_Docs

Files

     

Comments

f_Comment

Row

 

 

 

 

Case Reason Addendum Charge

Only an Issuer can initiate a dispute for the reason Addendum Charge and only over the following transaction types:

  • Purchase

  • Purchase ECOM

Initiation form Code Data type Necessity Default value

Reason of request

f_RequestReason

RequestReason

Yes

AddendumCharge

Dispute amount

f_DisputeAmount

Money

Yes

 

Payment method of the valid  transaction f_ValidPayment PaymentMethod Yes  
Purchase f_PaymentTrx Operation Yes if Payment method is By Mir/ MC/Visa card  
Purchase description f_CustomPayment Row Yes if Payment method is By other means  
Amount of the valid  transaction f_AmountValidPayment Money Yes if Payment method is By cash  
Date of the valid  transaction f_DateValidPayment Date Yes if Payment method is By cash  
Merchant of the valid  transaction f_MerchantValidPayment Row Yes if Payment method is By cash  

Documents

f_Docs

Files

   

Comments

f_Comment

Row

 

 



Listings

Listing RequestReason
 

Code

Value

ServiceNotPerformed

Goods or services not received

FailOperation (removed since 01.01.2023)

Unsuccessful transaction

OtherPaymentMethod

Paid by other means

SubscriptionCancelled

Canceled subscription

BadProduct

Defective merchandise

TechError

Technical error

NoCash

Non-receipt of cash at ATM

NoRefund

Credit not processed

DestinatorNotCredited (removed since 28.04.2021)

Non-receipt of P2P transfer

OriginatorInfo (removed since 28.04.2021)

Request for sender information

RefusalFromCredit (removed since 28.04.2021)

 Refusal of credit

DCC

Dynamic currency conversion

CashNotCredited Cash not credited
IncorrectAmount Incorrect operation amount
AddendumCharge Addendum charge


Listing PurchaseType
 

Code

Value

Goods

Goods

Service

Service/Works


Listing PaymentMethod 
 

Code

Value

BankCard

By Mir/MC/Visa card

Cash

By cash

OtherMethod

By other means


Listing NoCashType 
 

Code

Value

Full

Full

Partial

Partial


Listing RefusalReason  
 

Code

Value

Comments

AccountClosed

Account was closed

 

NoSuchAccountNumber

Card does not exist

 

RecepientRefusesCreditTransaction

Refusal of recipient

Only available for the following transaction types:

  • Cash-to-Card
  • Card-to-Card

Data Types


Money Type
 

Code

Data type

Value

amount

Decimal

Amount

currencyCode

Row

Numeric currency code according to the Russian Classification of Currencies (e.g., the Russian ruble is 643)


File Type
 

Code

Data type

Value

fileName

Row

File name

content

Row

File content in base64


Operation Type
 

Parameter

Data type

Description

pan

Row

PAN

arn

Row

Transaction number

cpd

Date

Business date