Simulating Cardholder Disputes
You can simulate cardholder disputes in the sandbox.
Create a payment using a specific, reserved card number. Set payment_method_options.3d_required to false. See Create Payment.
The following asynchronous webhooks provide information about the dispute object:
Reserved Card Numbers
To simulate a specific type of dispute, use one of the following card numbers in the payment_method object of the Create Payment request:
Card Number | Type of Cardholder Dispute |
|---|---|
4539922288211219 | Goods or services not provided. |
4556028624137080 | Subscription canceled. |
4556942399248726 | Counterfeit merchandise. |
5374500863109043 | Credit not processed. |
5132803130357186 | Cardholder dispute - miscellaneous. |
Example Disputed Transaction Request
curl -X post
https://sandboxapi.rapyd.net/v1/payments/
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'
-d '{
"amount": 26.49,
"currency": "USD",
"merchant_reference_id": "042620221450",
"payment_method": {
"type": "us_visa_card",
"fields": {
"number": "4539922288211219",
"expiration_month": "11",
"expiration_year": "25",
"cvv": "123",
"name": "John Doe"
}
},
"ewallets": [
{
"ewallet": "ewallet_e67c8ad63200d781470a04107fbd7c59",
"percentage": 100
}
],
"metadata": {
"merchant_defined": "created"
},
"capture": true,
"payment_method_options": {
"3d_required": false
}
}'Example Disputed Transaction Response
{
"status": {
"error_code": "",
"status": "SUCCESS",
"message": "",
"response_code": "",
"operation_id": "49e868c9-e886-4e0e-bb25-11aa47b6a9b7"
},
"data": {
"id": "payment_ce936f36d93bc9307a3db9ebfd3deaaa",
"amount": 26.49,
"original_amount": 26.49,
"is_partial": false,
"currency_code": "USD",
"country_code": "US",
"status": "CLO",
"description": "",
"merchant_reference_id": "042620221450",
"customer_token": "cus_62c7139fb12eb0c57a7cc52382b549c4",
"payment_method": "card_39d8aee398dfa5492fc2a0ea2822958f",
"payment_method_data": {
"id": "card_39d8aee398dfa5492fc2a0ea2822958f",
"type": "us_visa_card",
"category": "card",
"metadata": null,
"image": "",
"webhook_url": "",
"supporting_documentation": "",
"next_action": "not_applicable",
"name": "John Doe",
"last4": "1219",
"acs_check": "unchecked",
"cvv_check": "unchecked",
"bin_details": {
"type": null,
"brand": null,
"level": null,
"country": null,
"bin_number": "453992"
},
"expiration_year": "25",
"expiration_month": "11",
"fingerprint_token": "ocfp_f63d2a47a4ccca8613e8b00dc481d461",
"network_reference_id": "123456"
},
"expiration": 1651578901,
"captured": true,
"refunded": false,
"refunded_amount": 0,
"receipt_email": "",
"redirect_url": "",
"complete_payment_url": "",
"error_payment_url": "",
"receipt_number": "",
"flow_type": "",
"address": null,
"statement_descriptor": "Doc Team",
"transaction_id": "",
"created_at": 1650974101,
"metadata": {
"merchant_defined": "created"
},
"failure_code": "",
"failure_message": "",
"paid": true,
"paid_at": 1650974101,
"dispute": {
"id": "1d34c78e-4adf-49df-9450-f5bd78300834",
"token": "dispute_3e4862ba69665f04da530154f1019998",
"status": "ACT",
"amount": 26.49,
"currency": "USD",
"dispute_category": "Cardholder Dispute",
"dispute_reason_description": "Goods or Services Not Provided",
"original_transaction_currency": "USD",
"original_transaction_amount": 26.49,
"original_dispute_amount": 26.49,
"original_dispute_currency": "USD",
"original_transaction_id": "payment_ce936f36d93bc9307a3db9ebfd3deaaa",
"ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
"central_processing_date": null,
"created_at": 1650974101,
"updated_at": 1650974101,
"due_date": 1651751701,
"payment_method": "card_39d8aee398dfa5492fc2a0ea2822958f",
"payment_method_data": {
"id": "card_39d8aee398dfa5492fc2a0ea2822958f",
"type": "us_visa_card",
"category": "card",
"metadata": null,
"image": "",
"webhook_url": "",
"supporting_documentation": "",
"next_action": "not_applicable",
"name": "John Doe",
"last4": "1219",
"acs_check": "unchecked",
"cvv_check": "unchecked",
"bin_details": {
"type": null,
"brand": null,
"level": null,
"country": null,
"bin_number": "453992"
},
"expiration_year": "25",
"expiration_month": "11",
"fingerprint_token": "ocfp_f63d2a47a4ccca8613e8b00dc481d461"
},
"rate": 1,
"evidence": null,
"evidence_reason_code": null,
"pre_dispute": false
},
"refunds": null,
"order": null,
"outcome": null,
"visual_codes": {},
"textual_codes": {},
"instructions": [],
"ewallet_id": "ewallet_e67c8ad63200d781470a04107fbd7c59",
"ewallets": [
{
"ewallet_id": "ewallet_e67c8ad63200d781470a04107fbd7c59",
"amount": 26.49,
"percent": 100,
"refunded_amount": 0
}
],
"payment_method_options": {
"3d_required": false
},
"payment_method_type": "us_visa_card",
"payment_method_type_category": "card",
"fx_rate": 1,
"merchant_requested_currency": null,
"merchant_requested_amount": null,
"fixed_side": "",
"payment_fees": null,
"invoice": "",
"escrow": null,
"group_payment": "",
"cancel_reason": null,
"initiation_type": "customer_present",
"mid": "",
"next_action": "not_applicable",
"error_code": "",
"remitter_information": {}
}
}