---
title: "Record a dispute that the gateway cannot report"
description: "Use this when the payment's gateway sends no dispute events, for example Authorize.net."
canonical_url: "https://twominutebilling.com/help/developers/api-reference/webhooks/record-a-dispute-that-the-gateway-cannot-report"
---
# Record a dispute that the gateway cannot report

> Use this when the payment's gateway sends no dispute events, for example Authorize.net.

<api-operation method="POST" path="/v1/businesses/{biz}/payments/{pay}/disputes">
<template v-slot:docs="">

Your card processor tells you about the chargeback. Enter what it tells you. We book the dispute the same way as a gateway dispute: the funds move from `cash` to `disputed_funds`, and the dispute status is `under_review`. We refuse the request when the gateway reports disputes itself, or when the gateway already reported a dispute on this payment. The amount must not be more than the captured amount less refunds and other disputes that are not won.

## Path parameters

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        biz
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      Business id (biz_…)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        pay
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      The pay.
    </td>
  </tr>
</tbody>
</table>

## Headers

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        Idempotency-Key
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Safely retry writes — repeats return the original response. If a write FAILED after it had already taken effect, that failure is what repeats: the key is spent, and a new attempt needs a new key.
    </td>
  </tr>
</tbody>
</table>

## Body

The request body is **required**.

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        amount_minor
      </code>
    </td>
    
    <td>
      <code>
        integer
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      The disputed amount, in minor units of the payment currency.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        reason
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      The reason that the card holder gave, as the processor reports it. One of <code>
        fraudulent
      </code>
      
      , <code>
        unrecognized
      </code>
      
      , <code>
        duplicate
      </code>
      
      , <code>
        subscription_canceled
      </code>
      
      , <code>
        product_not_received
      </code>
      
      , <code>
        product_unacceptable
      </code>
      
      , <code>
        credit_not_processed
      </code>
      
      , <code>
        general
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        processor_reference
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Optional. The case number that your processor gave the dispute.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        opened_at
      </code>
    </td>
    
    <td>
      <code>
        integer
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      When the processor opened the dispute, in Unix seconds. Default now. It must not be in the future.
    </td>
  </tr>
</tbody>
</table>

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type; always <code>
        dispute
      </code>
      
      . One of <code>
        dispute
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The dispute's id.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        status
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The dispute's state. One of <code>
        needs_response
      </code>
      
      , <code>
        under_review
      </code>
      
      , <code>
        won
      </code>
      
      , <code>
        lost
      </code>
      
      , <code>
        closed
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        reason
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The reason for the dispute, as the gateway or the processor reports it.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        amount_minor
      </code>
    </td>
    
    <td>
      <code>
        integer
      </code>
    </td>
    
    <td>
      The disputed amount, in minor units.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        currency
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The currency (ISO-4217 code).
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        funds_withdrawn
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      True while the disputed funds are out of <code>
        cash
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        provider_key
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The gateway of the disputed payment.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        provider_dispute_id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The gateway's id for the dispute. Null when a person recorded the dispute.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        source
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      Who reported the dispute: <code>
        gateway
      </code>
      
       (its dispute events) or <code>
        operator
      </code>
      
       (a person). One of <code>
        gateway
      </code>
      
      , <code>
        operator
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        processor_reference
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The processor's case number. Only on a dispute that a person recorded.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        outcome_settable_by_operator
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      True when you can set the outcome with <code>
        POST /v1/businesses/{biz}/disputes/{id}/outcome
      </code>
      
      : the dispute is open, and a person recorded it or its gateway does not send a final state.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        provider_charge_id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The gateway's id for the disputed charge.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        payment_id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The disputed payment's internal id.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        invoice_id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The invoice's internal id.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        customer_id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The customer's internal id.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        evidence_due_by
      </code>
    </td>
    
    <td>
      <code>
        string · ISO-8601
      </code>
    </td>
    
    <td>
      When the gateway wants the evidence.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        opened_at
      </code>
    </td>
    
    <td>
      <code>
        string · ISO-8601
      </code>
    </td>
    
    <td>
      When the dispute opened.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        closed_at
      </code>
    </td>
    
    <td>
      <code>
        string · ISO-8601
      </code>
    </td>
    
    <td>
      When the dispute closed.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        created_at
      </code>
    </td>
    
    <td>
      <code>
        string · ISO-8601
      </code>
    </td>
    
    <td>
      When we recorded the dispute.
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        201
      </code>
    </td>
    
    <td>
      Recorded
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        400
      </code>
    </td>
    
    <td>
      The gateway reports disputes, or the amount is not correct
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        404
      </code>
    </td>
    
    <td>
      No such payment
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        409
      </code>
    </td>
    
    <td>
      The gateway already reported a dispute on this payment
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl -X POST "$TMBILLING_URL/v1/businesses/biz_XXXXXXXXXXXX01/payments/pay_XXXXXXXXXXXX01/disputes" \
  -H "Authorization: Bearer $TMBILLING_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "amount_minor": 2900,
    "reason": "fraudulent"
  }'
```

</template>

<template v-slot:response="">
<code-group>

```json [201 Created]
{
  "object": "dispute",
  "id": "dsp_XXXXXXXXXXXX01",
  "status": "needs_response",
  "reason": "Requested by the customer.",
  "amount_minor": 2900,
  "currency": "USD",
  "funds_withdrawn": false,
  "provider_key": "authorizenet",
  "provider_dispute_id": "Provider dispute id",
  "source": "gateway",
  "processor_reference": "Processor reference",
  "outcome_settable_by_operator": false,
  "provider_charge_id": "Provider charge id",
  "payment_id": "pay_XXXXXXXXXXXX01",
  "invoice_id": "inv_XXXXXXXXXXXX01",
  "customer_id": "cus_XXXXXXXXXXXX01",
  "evidence_due_by": "2026-04-14T09:30:00Z",
  "opened_at": "2026-03-14T09:30:00Z",
  "closed_at": "2026-03-14T09:30:00Z",
  "created_at": "2026-03-14T09:30:00Z"
}
```

```json [400 Bad Request]
{
  "error": {
    "type": "invalid_request_error",
    "message": "The gateway reports disputes, or the amount is not correct"
  }
}
```

```json [404 Not Found]
{
  "error": {
    "type": "invalid_request_error",
    "message": "No such payment"
  }
}
```

```json [409 Conflict]
{
  "error": {
    "type": "conflict_error",
    "message": "The gateway already reported a dispute on this payment"
  }
}
```

</code-group>
</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.
