Sign in

v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Get Reviews

Retrieve a list with reviews

get/v1/reviews

Query parameters

limitinteger
<table><tbody><tr><td><strong>Description:</strong></td><td>Number of records to be listed per page. </td></tr><tr><td><strong>Required:</strong></td><td>Optional</td></tr><tr><td><strong>Format:</strong></td><td>Numeric</td></tr><tr><td><strong>Default:</strong></td><td>25</td></tr><tr><td><strong>Example:</strong></td><td>25</td></tr></tbody></table>
pageinteger
<table><tbody><tr><td><strong>Description:</strong></td><td>A number that represents the current page number. </td></tr><tr><td><strong>Required:</strong></td><td>Optional</td></tr><tr><td><strong>Format:</strong></td><td>Numeric</td></tr><tr><td><strong>Default:</strong></td><td>1</td></tr><tr><td><strong>Example:</strong></td><td>1</td></tr></tbody></table>
review_desc[eq]'single_transaction_value_limit' | 'daily_transaction_value_limit' | 'daily_transaction_count_limit' | 'hourly_transaction_count_limit' | 'hourly_transaction_value_limit' | 'mountly_transaction_count_limit' | 'mountly_transaction_value_limit' | 'hourly_invalid_card_count_limit'

Different constraints.

includestring

Include the records from charges.

created_at[intl]integer
<table><tbody><tr><td><strong>Description:</strong></td><td>In the specified number of days. </td></tr><tr><td><strong>Required:</strong></td><td>Optional</td></tr><tr><td><strong>Format:</strong></td><td>integer</td></tr><tr><td><strong>Default:</strong></td><td>none</td></tr><tr><td><strong>Example:</strong></td><td>365</td></tr><tr><td><strong>Valid Values:</strong></td><td>positive whole numbers</td></tr></tbody></table>
created_at[eq]string
<table><tbody><tr><td><strong>Description:</strong></td><td>Date is equal to. </td></tr><tr><td><strong>Required:</strong></td><td>Optional</td></tr><tr><td><strong>Format:</strong></td><td>string</td></tr><tr><td><strong>Default:</strong></td><td>none</td></tr><tr><td><strong>Example:</strong></td><td>2023/06/01</td></tr><tr><td><strong>Valid Values:</strong></td><td>any string in date format</td></tr></tbody></table>
created_at[lte]string
<table><tbody><tr><td><strong>Description:</strong></td><td>Date is less than or equal to. </td></tr><tr><td><strong>Required:</strong></td><td>Optional</td></tr><tr><td><strong>Format:</strong></td><td>string</td></tr><tr><td><strong>Default:</strong></td><td>none</td></tr><tr><td><strong>Example:</strong></td><td>2023/06/01</td></tr><tr><td><strong>Valid Values:</strong></td><td>any string in date format</td></tr></tbody></table>
created_at[gte]string
<table><tbody><tr><td><strong>Description:</strong></td><td>Date is greater than or equal to. </td></tr><tr><td><strong>Required:</strong></td><td>Optional</td></tr><tr><td><strong>Format:</strong></td><td>string</td></tr><tr><td><strong>Default:</strong></td><td>none</td></tr><tr><td><strong>Example:</strong></td><td>2023/06/01</td></tr><tr><td><strong>Valid Values:</strong></td><td>any string in date format</td></tr></tbody></table>
created_at[gt]string
<table><tbody><tr><td><strong>Description:</strong></td><td>Date is great than. </td></tr><tr><td><strong>Required:</strong></td><td>Optional</td></tr><tr><td><strong>Format:</strong></td><td>string</td></tr><tr><td><strong>Default:</strong></td><td>none</td></tr><tr><td><strong>Example:</strong></td><td>2023/06/01</td></tr><tr><td><strong>Valid Values:</strong></td><td>any string in date format</td></tr></tbody></table>
created_at[lt]string
<table><tbody><tr><td><strong>Description:</strong></td><td>Date is less than. </td></tr><tr><td><strong>Required:</strong></td><td>Optional</td></tr><tr><td><strong>Format:</strong></td><td>string</td></tr><tr><td><strong>Default:</strong></td><td>none</td></tr><tr><td><strong>Example:</strong></td><td>2023/06/01</td></tr><tr><td><strong>Valid Values:</strong></td><td>any string in date format</td></tr></tbody></table>
status[eq]'approved' | 'rejected' | 'waiting_for_approval'

Filter by status

Response

200

Example response

{
  "data": [
    {
      "object": "Review",
      "id": "EGemLZhhhZwplJnz",
      "review_desc": "daily_transaction_value_limit",
      "status": "approved",
      "charge_id": "BoLWODWRnoLnDOXy",
      "comments": "Approved by merchant",
      "approved_date": "2023-01-24 16:12:07",
      "created_at": 1674576710,
      "updated_at": 1674576727
    }
  ],
  "meta": {
    "include": [
      "charge"
    ],
    "pagination": {
      "total": 32,
      "count": 3,
      "per_page": 3,
      "current_page": 1,
      "total_pages": 11,
      "links": {
        "next": "http://xxxxxpayarc.net/v1/reviews?limit=3&search=&page=2"
      }
    }
  }
}