PApayarc

Get Agent Cases

Changed on

This endpoint retrieves a list of chargebacks for all the merchant accounts associated with a specific agent. The data returned is constrained by optional date filters and a search string.

get/v1/agent-hub/cases

Request

  • Base URL
    https://testapi.payarc.net
  • URL
    https://testapi.payarc.net/v1/agent-hub/cases
  • Auth
    API key in header Authorization

Query parameters

date_type'date_resolved' | 'transaction_date' | 'date_posted' | 'date_loaded' | 'date_second_request' | 'date_warehouse' | 'report_date' | 'last_updated_date' | 'responded_date' required

Type of data that will be searched and constrained by Inial and End dates<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Allowed Values</b></td><td style='text-align: center;'><b>Examples</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>String</td><td>N/A</td><td>N/A</td><td>date_resolved, transaction_date, date_posted, date_loaded, date_second_request, date_warehouse, report_date, last_updated_date, responded_date</td><td>responded_date</td><td>Returned list will be constranted by this date</td></tr></table>

fromstring date required

Oldest date to search for<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Allowed Values</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>YYYY-MM-DD</td><td>N/A</td><td>N/A</td><td>Valid date</td><td>2024-01-29</td></tr></table>

tostring date

Newest date to search for<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Allowed Values</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>YYYY-MM-DD</td><td>N/A</td><td>N/A</td><td>Valid date after inital date</td><td>2024-01-31</td></tr></table>

searchstring

Search string<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Allowed Values</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>char</td><td>0</td><td>128</td><td>valid string</td><td>goods</td></tr></table>

Response

200

Example response

{
  "header_data": [
    {
      "column_name": "DBA Name",
      "sortable": true,
      "column_id": "dba",
      "type": "string"
    }
  ],
  "row_data": [
    {
      "object": "Cases",
      "id": "QzR2Cx78m492LDv",
      "dba": "Tech Edge",
      "mid": "0567000000841121",
      "full_reason_code": "4837",
      "item_type": "01",
      "resolution_to": "M",
      "debit_credit": "D",
      "trans_code": "05",
      "reason_code": "4837",
      "bin_ica": "026037",
      "card_brand": "2",
      "date_resolved": "2025-01-24",
      "acquirer_reference_number": "82654291111900888788551",
      "original_reference_number": "gc1736228010111",
      "foreign_domestic": "D",
      "mcc": "7311",
      "auth_code": "476042",
      "date_posted": "2025-01-07",
      "date_loaded": "2025-01-24",
      "card_number_prefix": "511044",
      "card_last4": "4679",
      "merchant_dba_name": "TECHEDGE, LLC",
      "merchant_city": "NEW YORK",
      "merchant_state": "NY",
      "merchant_zip": "10001-7607",
      "group": "500000",
      "tsys_bank_number": "5670",
      "date_warehouse": "2025-01-24",
      "transaction_id": "MPF8878810111",
      "merchant_amount": 98.59,
      "family_id": "56461144",
      "created_at": "2025-01-25T07:12:18.000000Z",
      "updated_at": "2025-01-25T07:12:32.000000Z",
      "fingerprint": "aee887881111f2dd3333f64f98c046ef",
      "log_id": 77305,
      "bank_number": 5670,
      "tsys_fiserv_indicator": "T",
      "latest_secondary_case_id": 4172269,
      "report_date": "2025-01-24",
      "case_number": "2025024022555",
      "is_primary_case": true,
      "transaction_date": "2025-01-08",
      "case_amount": 98.59,
      "reason_desc": "Fraud",
      "case_type": "First Chargeback",
      "status": "Pending",
      "card_type": "M",
      "card_number": "511333*********4679",
      "response": "Not responded",
      "last_updated_date": "2025-01-24",
      "responded_date": "2025-02-07",
      "full_reason_desc": "No Cardholder Authorization"
    }
  ],
  "meta": {
    "include": [
      "file"
    ]
  }
}

Changes