Dispute Created Webhook

The PAYMENT_DISPUTE_CREATED webhook is sent when a dispute is created.

Creation of a dispute requires the action of a third party, and this webhook is sent when the last required third-party action is completed.

To simulate a dispute in the sandbox, see Simulating Cardholder Disputes.

Parameters

Webhook Header Parameters

Webhook Root Parameters

- created_at
- Time that the webhook was created, in Unix time.
  Note
  Inside the data object, some webhooks have another created_at field that refers to a different event.
- data
- Contains the actual data of the webhook.
  For details, see below.
- extended_timestamp
- Time in milliseconds that the webhook was created, in Unix time.
- id
- ID of the webhook. String starting with wh_.
- status
- Status of the webhook. One of the following:
  - NEW
  - CLO - Closed.
  - ERR - Error.
  - RET - Re-sent.
  Note
  Inside the data object, some webhooks have another status field that refers to a different event.
- trigger_operation_id
- ID of the operation that triggered the webhook. UUID.
- type
- Name of the webhook type.
  Note
  The name in the Client Portal is different.

Webhook Data Parameters

- amount
- Amount that Rapyd deducted from the merchant due to the dispute.
- central_processing_date
- The date the transaction was processed by the card network.
- created_at
- Time of creation of the dispute, in Unix time.
- currency
- Three-letter ISO 4217 code for the currency used in the amount field.
- dispute_category
- The category of dispute that was provided by the card network.
- dispute_reason_description
- A short description of the reason for the dispute.
- due_date
- The latest date for the dispute to be contested, in Unix time.
- evidence
- Reserved.
- evidence_reason_code
- Reserved.
- ewallet_id
- ID of the wallet that the money is paid into. String starting with ewallet_. Relevant when the request includes a single wallet.
- id
- Reserved.
- original_dispute_amount
- Amount of the dispute, as reported to Rapyd.
- original_dispute_currency
- Currency of the disputed payment. Three-letter ISO 4217 code.
- original_transaction_amount
- Amount of the original payment.
- original_transaction_currency
- Currency of the original_transaction_amount. Three-letter ISO 4217 code.
- original_transaction_id
- ID of the payment that the dispute is charged against. String starting with payment_.
- payment_method
- ID of the payment method. String starting with card_.
- payment_method_data
- Details of the payment method that was used for the payment.
  account_last4
  Last four digits of the IBAN.
  Relevant to bank transfers.
  acs_check
  Results of the Access Control Server (ACS) check. Possible values:
  pass
  fail
  unavailable
  unchecked
  Relevant to cards.
  avs_check
  Results of the Address Verification Service (AVS) check.
  Relevant to Visa, Mastercard, Amex, and Discover cards.
  authentication_url
  URL of a page where the customer enters the IBAN and phone number for authentication.
  Relevant to some bank transfer payment methods.
  bic_swift
  BIC (Bank Identifier Code)/SWIFT code.
  bin_details
  Bank identification details. Relevant to cards.
  bin_number
  Bank identification number of the issuing bank.
  brand
  The brand of the card.
  country
  The country where the card was issued.
  issuer
  Name of the bank that issued the card.
  level
  The level of the card.
  type
  The type of card.
  category
  Category of payment method. One of the following:
  bank_redirect
  bank_transfer
  card
  cardtocard
  cash
  ewallet
  rapyd_ewallet
  cvv_check
  Verification of the card’s CVV. Valid values:
  pass
  fail
  unavailable
  unchecked
  Relevant to cards.
  digital_wallet
  Information about the digital wallet.
  pan_type
  Describes the type of PAN.
  type
  Describes the type of digital wallet.
  expiration_month
  The month when the expiration of the card occurs.
  Relevant to cards.
  expiration_year
  The year when the expiration of the card occurs.
  Relevant to cards.
  fingerprint_token
  Hash of the card number, expiration date and CVV.
  Relevant to cards.
  id
  ID of the payment method.
  Note
  Card payment method ID is not returned when the next_action is 3d_verification or when save_payment_method was set to false.
  image
  A URL to the image of the icon for the payment method type.
  last4
  Last four digits of the card.
  Relevant to cards.
  metadata
  A JSON object defined by the client. See Metadata.
  network_reference_id
  Identifier for use in a recurring card payment.
  next_action
  Indicates the next action for completing the payment. One of the following values:
  3d_verification - The next action is 3DS. Relevant to card payments.
  pending_capture - The next action is pending the capture of the amount. Relevant to card payments when the amount is not zero.
  pending_confirmation - The next action is pending the confirmation for the payment. Relevant to all payment methods excluding card payment.
  not_applicable - The payment has completed or the next action is not relevant.
  type
  Type of the payment card. Possible values:
  credit
  debit
  prepaid
  unknown
  Relevant to cards.
  supporting_documentation
  Reserved.
  webhook_url
  Reserved.
- pre_dispute
- When true, indicates that the disputed payment was automatically refunded based on pre-determined criteria.
- rate
- FX rate.
  Relevant to payments with FX.
- status
- 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) - The card issuer challenged a previously contested dispute. The dispute is being reviewed.
  - ARB (Arbitration) - The merchant rejected a pre-arbitration outcome. Rapyd is awaiting a ruling by an arbitration committee of the card schemes.
  - LOS (Loss) - The merchant lost the dispute. Funds were deducted from the merchant wallet.
  - WIN (Win) - The merchant won the dispute. Funds were credited to the merchant wallet.
  - REV (Reverse) - The card issuer reversed the dispute. Funds were credited to the merchant wallet. Final status.
- token
- ID of the dispute. String starting with dispute_.
- updated_at
- Time that the dispute was last updated, in Unix time.

PAYMENT_DISPUTE_CREATED Webhook

{
    "id": "wh_3892cd134d9be8e9df25f41697f7cf91",
    "data": {
        "id": "56733c94-2580-488e-984c-afb9257d902b",
        "rate": 1,
        "token": "dispute_6bd95ecec6bee6a505d39b56dbded2ec",
        "amount": 10,
        "status": "ACT",
        "currency": "USD",
        "due_date": 1651726898,
        "evidence": null,
        "created_at": 1650949298,
        "ewallet_id": "ewallet_e2150f478c15d97b807b9ed179b798a0",
        "updated_at": 1650949298,
        "pre_dispute": false,
        "payment_method": "card_1bdedd5b9467409accd26edbe0358a8c",
        "dispute_category": "Authorization",
        "payment_method_data": {
            "id": "card_1bdedd5b9467409accd26edbe0358a8c",
            "name": "John Doe",
            "type": "at_mastercard_card",
            "image": "",
            "last4": "0101",
            "category": "card",
            "metadata": null,
            "acs_check": "unchecked",
            "cvv_check": "unchecked",
            "bin_details": {
                "type": "CREDIT",
                "brand": "MASTERCARD",
                "level": "PLATINUM",
                "country": "US",
                "bin_number": "523929"
            },
            "next_action": "not_applicable",
            "webhook_url": "",
            "expiration_year": "25",
            "expiration_month": "04",
            "fingerprint_token": "ocfp_335b40f64d5bb87d9b5d1f2cdffced6d",
            "supporting_documentation": ""
        },
        "evidence_reason_code": null,
        "central_processing_date": 0,
        "original_dispute_amount": 10,
        "original_transaction_id": "payment_185b8ef92ef6f3a26ef0ac5fe41e6263",
        "original_dispute_currency": "USD",
        "dispute_reason_description": "Authorization Errors",
        "original_transaction_amount": 10,
        "original_transaction_currency": "USD"
    },
    "type": "PAYMENT_DISPUTE_CREATED",
    "status": "NEW",
    "created_at": 1650949298,
    "extended_timestamp": 1650949298936,
    "trigger_operation_id": "de786a9f-36dd-468e-9e9a-a8d5dcdd7e33"
}

In this section:

Documentation

Dispute Created Webhook

Note

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Note

Search results