---
title: "List every gateway decline and how this business handles it"
description: "The whole catalogue, not just the configurable half."
canonical_url: "https://twominutebilling.com/help/developers/api-reference/payments/list-every-gateway-decline-and-how-this-business"
---
# List every gateway decline and how this business handles it

> The whole catalogue, not just the configurable half.

<api-operation method="GET" path="/v1/businesses/{biz}/decline_rules">
<template v-slot:docs="">

A code we recognise that no rule names is returned with `overridable: false` — omitting it would suggest we do not handle a decline we handle correctly.

## 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>
</tbody>
</table>

## Query parameters

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

<tbody>
  <tr>
    <td>
      <code>
        gateway
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Only the rules for this gateway.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        overridden
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Only rows this business has changed.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        gateway_account
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Resolve overrides for ONE gateway account. An account-scoped setting beats the business-wide one.
    </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>
        list
      </code>
      
      . One of <code>
        list
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      The rows on this page.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type; always <code>
        decline_rule
      </code>
      
      . One of <code>
        decline_rule
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      e.g. stripe.code.expired_card
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.overridable
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      False for a code we recognise that no RULE names. Its answer is still real and a code-level override still governs it; there is simply no rule id to aim a rule-level PATCH at, and one aimed there answers 404.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.gateway
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The gateway this rule applies to. One of <code>
        stripe
      </code>
      
      , <code>
        paypal
      </code>
      
      , <code>
        razorpay
      </code>
      
      , <code>
        gocardless
      </code>
      
      , <code>
        braintree
      </code>
      
      , <code>
        cashfree
      </code>
      
      , <code>
        authorizenet
      </code>
      
      , <code>
        adyen
      </code>
      
      , <code>
        checkoutcom
      </code>
      
      , <code>
        mollie
      </code>
      
      , <code>
        square
      </code>
      
      , <code>
        payu
      </code>
      
      , <code>
        cybersource
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.matches
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      The predicate that selects this rule. First match wins.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.code
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      Our canonical code, e.g. expired_card
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.error_id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The canonical code on the namespaced axis: gateway.<family>.<code>, using Eleven families, so an imported book aggregates with ours.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.family
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The rule's decline family.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.built_in
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      The rule's built-in behavior.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.override
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      Null until this business changes something.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.effective
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      What collection will actually do.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        orphaned_overrides
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      Settings whose target a deploy removed. Surfaced rather than hidden: a merchant whose preference silently stopped applying has no other way to discover it.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        code_overrides
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      Settings made on a canonical CODE. Listed separately because one can be invisible in <code>
        data
      </code>
      
      : when every rule under it also has its own row, the narrower rows win.
    </td>
  </tr>
</tbody>
</table>

## Status codes

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

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      Success
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        404
      </code>
    </td>
    
    <td>
      No such business, or no such gateway account
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl "$TMBILLING_URL/v1/businesses/biz_XXXXXXXXXXXX01/decline_rules" \
  -H "Authorization: Bearer $TMBILLING_API_KEY"
```

</template>

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

```json [200 OK]
{
  "object": "list",
  "data": [
    {
      "object": "decline_rule",
      "id": "stripe.code.expired_card",
      "overridable": false,
      "gateway": "stripe",
      "matches": {
        "field": "email",
        "op": "eq",
        "value": "West"
      },
      "code": "expired_card"
    }
  ],
  "orphaned_overrides": [
    {
      "id": "stripe.code.expired_card",
      "decline_rule": "stripe.code.expired_card"
    }
  ],
  "code_overrides": [
    {
      "object": "decline_code_override",
      "code": "welcome-10",
      "retriable": false,
      "message": "Requested by the customer.",
      "exposed_to_payer": false,
      "updated_by": "maya@example.com"
    }
  ]
}
```

```json [404 Not Found]
{
  "error": {
    "type": "invalid_request_error",
    "message": "No such business, or no such gateway account"
  }
}
```

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


## Sitemap

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