Skip to main content

Documentation

List Disputes

Retrieve a detailed list of disputes.

    • ending_before

    • The ID of the dispute created after the last dispute you want to retrieve. String starting with dispute_.

    • limit

    • The maximum number of disputes to return. Range: 1-100.

      10

    • payment

    • ID of the payment that the dispute is charged against. String starting with payment_.

    • starting_after

    • The ID of the dispute created before the first dispute you want to retrieve. String starting with dispute_.

    • 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.

      • 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.

  • /v1/disputes

  • List Disputes

  • curl -X get
    https://sandboxapi.rapyd.net/v1/disputes
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "3011dea4-f1c6-4151-a83e-82928f0c20ff"
        },
        "data": [
            {
                "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",
                "ewallet_id": null,
                "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,
                "pre_dispute": false
            },
            {
                "id": "7d78f2ca-23aa-47be-82e4-7b021de274b1",
                "token": "dispute_6440a9eba65af5cc0dff80df40ac29c3",
                "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",
                "ewallet_id": null,
                "central_processing_date": null,
                "created_at": 1640532796,
                "updated_at": 1641114338,
                "due_date": 1641310396,
                "payment_method": "card_c7af5d358a39bcc17cbd93ecf7fb74a9",
                "payment_method_data": {
                    "id": "card_c7af5d358a39bcc17cbd93ecf7fb74a9",
                    "type": "fr_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,
                        "country": null,
                        "bin_number": "453992"
                    },
                    "expiration_year": "22",
                    "expiration_month": "11",
                    "fingerprint_token": "ocfp_f63d2a47a4ccca8613e8b00dc481d461"
                },
                "rate": 1,
                "evidence": null,
                "pre_dispute": false
            }
        ]
    }
  • List Disputes - by Payment ID

  • curl -X get
    https://sandboxapi.rapyd.net/v1/disputes?payment=payment_ce936f36d93bc9307a3db9ebfd3deaaa
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "c75c5ff8-cade-493d-af27-891ff2289ea5"
        },
        "data": [
            {
                "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",
                "ewallet_id": null,
                "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,
                "pre_dispute": false
            }
        ]
    }