Describes the fields contained in REST messages and webhooks for disputes of payments.
Properties
Name | Type | Required | Description |
---|---|---|---|
id_ | str |
❌ | Reserved. |
token | str |
❌ | ID of the dispute. String starting with dispute_. |
status | DisputeStatus |
❌ | Indicates the status of the dispute operation. One of the following values: _ ACT (Active) - The dispute was initiated and is awaiting action by the merchant. _ RVW (Review) - Rapyd is reviewing the merchant's evidence contesting the dispute. _ PRA (Pre-Arbitration) - Rapyd is reviewing the merchant's evidence contesting a previously contested dispute. _ ARB (Arbitration) - The merchant rejected a pre-arbitration outcome. Rapyd is awaiting a ruling by an arbitration committee from the card schemes. _ LOS (Lose) - The merchant lost the dispute. Funds were deducted from the merchant wallet. Final status. _ WIN (Win) - The merchant won the dispute. Funds were credited to the merchant wallet. Final status. * REV (Reverse) - The card issuer reversed the dispute. Funds were credited to the merchant wallet. Final status. |
amount | float |
❌ | Amount that Rapyd deducted from the merchant due to the dispute. |
currency | str |
❌ | Three-letter ISO 4217 code for the currency used in the amount field. |
dispute_category | str |
❌ | The category of dispute that was provided by the card network. |
dispute_reason_description | str |
❌ | A short description of the reason for the dispute. |
original_transaction_currency | str |
❌ | |
original_transaction_amount | float |
❌ | Amount of the original payment. |
original_dispute_amount | float |
❌ | Amount of the dispute, as reported to Rapyd. |
original_dispute_currency | str |
❌ | |
original_transaction_id | str |
❌ | ID of the payment that the dispute is charged against. String starting with payment_. |
ewallet_id | str |
❌ | ID of the wallet that the money is paid into. String starting with ewallet_. Relevant when the request includes a single wallet. Response only. |
central_processing_date | float |
❌ | The date the transaction was processed by the card network. |
created_at | float |
❌ | Time of creation of the dispute, in Unix time. Response only. |
updated_at | float |
❌ | Time that the dispute was last updated, in Unix time. Response only. |
due_date | float |
❌ | The latest date for the dispute to be contested in Unix time. Response only. |
payment_method | str |
❌ | ID of the payment method. String starting with card_. |
payment_method_data | dict |
❌ | Details of the payment method that was used for the payment. See Payment Method Data Object. Response only. |
rate | float |
❌ | FX rate. Relevant to FX payments. |
evidence | str |
❌ | Reserved. |
evidence_reason_code | str |
❌ | Reserved. |
pre_dispute | bool |
❌ | When true, indicates that the disputed payment was automatically refunded based on pre-determined criteria. Response only. |
arn | str |
❌ | An Acquirer Reference Number (ARN) is a unique number assigned to a credit card transaction as it moves through the payment flow. Banks can use it to help trace the payment/ refund if it appears to be missing. An ARN will be available for Visa and Mastercard charges. |
Indicates the status of the dispute operation. One of the following values: _ ACT (Active) - The dispute was initiated and is awaiting action by the merchant. _ RVW (Review) - Rapyd is reviewing the merchant's evidence contesting the dispute. _ PRA (Pre-Arbitration) - Rapyd is reviewing the merchant's evidence contesting a previously contested dispute. _ ARB (Arbitration) - The merchant rejected a pre-arbitration outcome. Rapyd is awaiting a ruling by an arbitration committee from the card schemes. _ LOS (Lose) - The merchant lost the dispute. Funds were deducted from the merchant wallet. Final status. _ WIN (Win) - The merchant won the dispute. Funds were credited to the merchant wallet. Final status. * REV (Reverse) - The card issuer reversed the dispute. Funds were credited to the merchant wallet. Final status.
Properties
Name | Type | Required | Description |
---|---|---|---|
ACT | str |
✅ | "ACT" |
RVW | str |
✅ | "RVW" |
PRA | str |
✅ | "PRA" |
ARB | str |
✅ | "ARB" |
LOS | str |
✅ | "LOS" |
WIN | str |
✅ | "WIN" |
REV | str |
✅ | "REV" |