Issuing Dispute Updated Webhook
The ISSUING_DISPUTE_UPDATED webhook is sent when a dispute is updated.
Note
The endpoint for webhooks is unique for each client. To set up a webhook endpoint, see Defining a Webhook Endpoint.
Content-Type
Indicates that the data appears in JSON format. Set to application/json.
salt
Random string.
signature
Signature calculated for each webhook individually.
timestamp
Timestamp for the webhook, in Unix time (seconds).
created_at
Time that the webhook was created, in Unix time.
Note
Inside the
dataobject, some webhooks have anothercreated_atfield 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
dataobject, some webhooks have anotherstatusfield 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.
token
ID of the dispute. String starting with dispute_.
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
amountfield.
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 inUnix 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.
account_name_inquiry
Data about the account name inquiry (ANI).
account_name_inquiry_result
Result of the account name inquiry. One of the following values:
match - Indicates that the name provided in the request fully matched the issuing bank's records.
partial match - Indicates that the name provided in the request partially matched the issuing bank's records.
no match - Indicates that the name provided in the request did not match the issuing bank's records.
not performed - Indicates that the account name inquiry was not performed.
not supported - Indicates that the payment method does not support account name inquiries.
account_name_inquiry_details
Indicates the degree of matching each part of the cardholder's name.
first_name
Indicates the result of matching the cardholder's given name. One of the following values:
match - Indicates that the first name provided in the request fully matched the first name in the issuing bank's records.
partial match - Indicates that the first name provided in the request partially matched the first name in the issuing bank's records.
no match - Indicates that first the name provided in the request did not match the first name in the issuing bank's records.
middle_name
indicates the result of matching the cardholder's middle name. One of the following values:
match - Indicates that the middle name provided in the request fully matched the middle name in the issuing bank's records.
partial match - Indicates that the middle name provided in the request partially middle the first name in the issuing bank's records.
no match - Indicates that the middle name provided in the request did not match the middle name in the issuing bank's records.
last_name
indicates the result of matching the cardholder's family name. One of the following values:
match - Indicates that the last name provided in the request fully matched the family name in the issuing bank's records.
partial match - Indicates that the last name provided in the request partially matched the family name in the issuing bank's records.
no match - Indicates that the last name provided in the request did not match the family name in the issuing bank's records.
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.
full_name
Full name of the cardholder, as submitted for account name inquiry (ANI).
first_name
The cardholder's given name.
middle_name
The cardholder's middle name.
last_name
The cardholder's family name.
id
ID of the payment method.
Note
Card payment method ID is not returned when the
next_actionis 3d_verification or whensave_payment_methodwas 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.
payment_account_reference
Payment Account Reference (PAR) number. An alphanumeric code that associates payments made by different tokens and physical cards that all represent the same payment account number (PAN). Appears only in card responses that include an EMVCo-compliant PAR.
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 FX payments.
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 (Lose) - 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.
updated_at
Time that the dispute was last updated, in Unix time.
ISSUING_DISPUTE_UPDATED Webhook
{ "id": "wh_6c28f89408ea91d710ee8954ddac31fb", "data": { "id": "5ea10461-9eaa-4134-8d97-8d6ad0301954", "rate": 1, "token": "dispute_ed8e5cde9f5843a0009eb38336f1873c", "amount": 15, "status": "ACT", "currency": "USD", "due_date": 1694917992, "evidence": null, "created_at": 1691461992, "ewallet_id": "ewallet_d8c1d858c3a7d5dfab1cf4a422555fcc", "updated_at": 1691461992, "dispute_category": "Authorization", "evidence_reason_code": null, "central_processing_date": null, "original_dispute_amount": 15, "original_transaction_id": "cardauth_a509d6808e1a961da1da0053cfd6d21a", "original_dispute_currency": "USD", "dispute_reason_description": "", "original_transaction_amount": 20, "original_transaction_currency": "USD" }, "type": "ISSUING_DISPUTE_UPDATED", "status": "NEW", "created_at": 1691461992, "extended_timestamp": 1691461992394, "trigger_operation_id": "d092d957-c3cb-4071-bc72-0d1626ba0323" }
The number of seconds elapsed since the beginning of the Unix epoch, which was 00:00:00 GMT on January 1, 1970. 10-digit integer.
A number for a bank account that is used for international transfers.
A server used by issuing banks to authenticate card users by 3DS authentication.
For card transactions, a service that checks whether the cardholder's billing address matches the address for the cardholder's account.
An alphanumeric identifier for financial institutions, also known informally as a SWIFT code or SWIFT/BIC code.
A numeric identifier for financial institutions. It appears as the first four to six digits on a payment card.
A unique number for a payment card, usually 14 to 19 digits in length. Also known as a card number, payment card number or funding primary account number (FPAN).
A numeric code printed on the card, consisting of 3 or 4 digits. Use of the code indicates that the person making the transaction has access to the physical card. This value cannot be stored in any way. Also known as CCV, CID, CSC and CVC.
A protocol that provides increased security for card-not-present transactions. Rapyd supports version 2.2.