List Review Queue Items

Overview

Retrieve a paginated list of Review Queue Items. These items track manual review processes, typically for Settlements, Identities, or Fees that require approval before funds can be released or actions completed.

Resource Access

User Permissions: Admin users only
Endpoint: GET /review_queue

Arguments

Parameter	Type	Required	Description
limit	integer	No	Maximum number of records to return (default: 10)
application_id	string	No	Filter by Application ID
entity_id	string	No	Filter by the ID of the reviewed entity (e.g., Settlement ID)
entity_type	string	No	Filter by entity type: SETTLEMENT_V2, IDENTITY, or FEE
outcome	string	No	Filter by outcome: PENDING, ACCEPTED, REJECTED, or MANUAL_REVIEW

Example Request (All Pending Items)

curl -X GET \
  'https://api.ahrvo.network/payments/na/review_queue?outcome=PENDING&limit=20' \
  -u username:password \
  -H 'Content-Type: application/json'

Example Request (Filter by Entity Type)

curl -X GET \
  'https://api.ahrvo.network/payments/na/review_queue?entity_type=SETTLEMENT_V2&outcome=PENDING' \
  -u username:password \
  -H 'Content-Type: application/json'

Example Response

{
  "_embedded": {
    "review_queue_items": [
      {
        "id": "RQreviewQueue123",
        "created_at": "2023-12-10T10:30:00Z",
        "updated_at": "2023-12-10T10:30:00Z",
        "application": "APapplicationExample456",
        "completed_at": null,
        "entity_id": "STsettlementExample789",
        "entity_type": "SETTLEMENT_V2",
        "outcome": "PENDING",
        "outcome_reason": [],
        "processor_type": "LITLE_V1",
        "review_type": "CREATED",
        "reviewed_by": null,
        "tags": {
          "priority": "high",
          "merchant_name": "Acme Corp"
        },
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/review_queue/RQreviewQueue123"
          },
          "settlement": {
            "href": "https://api.ahrvo.network/payments/na/settlements/STsettlementExample789"
          },
          "application": {
            "href": "https://api.ahrvo.network/payments/na/applications/APapplicationExample456"
          }
        }
      },
      {
        "id": "RQreviewQueue456",
        "created_at": "2023-12-09T15:20:00Z",
        "updated_at": "2023-12-10T09:15:00Z",
        "application": "APapplicationExample456",
        "completed_at": "2023-12-10T09:15:00Z",
        "entity_id": "IDidentityExample111",
        "entity_type": "IDENTITY",
        "outcome": "ACCEPTED",
        "outcome_reason": [],
        "processor_type": null,
        "review_type": "UPDATED",
        "reviewed_by": "USuserExample222",
        "tags": {
          "kyc_review": "passed",
          "risk_score": "low"
        },
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/review_queue/RQreviewQueue456"
          },
          "identity": {
            "href": "https://api.ahrvo.network/payments/na/identities/IDidentityExample111"
          },
          "application": {
            "href": "https://api.ahrvo.network/payments/na/applications/APapplicationExample456"
          },
          "reviewed_by_user": {
            "href": "https://api.ahrvo.network/payments/na/users/USuserExample222"
          }
        }
      },
      {
        "id": "RQreviewQueue789",
        "created_at": "2023-12-08T11:00:00Z",
        "updated_at": "2023-12-08T14:30:00Z",
        "application": "APapplicationExample456",
        "completed_at": "2023-12-08T14:30:00Z",
        "entity_id": "STsettlementExample333",
        "entity_type": "SETTLEMENT_V2",
        "outcome": "REJECTED",
        "outcome_reason": [
          "INSUFFICIENT_FUNDS",
          "RISK_THRESHOLD_EXCEEDED"
        ],
        "processor_type": "VANTIV_V1",
        "review_type": "CREATED",
        "reviewed_by": "USuserExample222",
        "tags": {
          "flagged_reason": "velocity_check",
          "merchant_id": "MUmerchant999"
        },
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/review_queue/RQreviewQueue789"
          },
          "settlement": {
            "href": "https://api.ahrvo.network/payments/na/settlements/STsettlementExample333"
          },
          "application": {
            "href": "https://api.ahrvo.network/payments/na/applications/APapplicationExample456"
          },
          "reviewed_by_user": {
            "href": "https://api.ahrvo.network/payments/na/users/USuserExample222"
          }
        }
      }
    ]
  },
  "page": {
    "offset": 0,
    "limit": 20,
    "count": 3
  },
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/review_queue?outcome=PENDING&limit=20"
    }
  }
}

Additional Information

Review Queue Purpose: The review queue is a risk management and compliance tool
- Flags transactions, settlements, or identities that need manual approval
- Prevents automatic processing of high-risk or unusual activity
- Provides audit trail for compliance requirements
- Enables fraud prevention and AML/KYC reviews
Entity Types:
- SETTLEMENT_V2: Settlement/payout reviews (most common)
  - Triggered by large amounts, velocity limits, or risk rules
  - Settlement is held until ACCEPTED
  - Common reasons: First payout, unusual amount, merchant under review
- IDENTITY: Identity/KYC reviews
  - Triggered during merchant onboarding or profile updates
  - May require document verification or manual KYC review
  - Common reasons: Incomplete information, high-risk business type, sanctions screening
- FEE: Fee transaction reviews
  - Triggered by unusual fee structures or adjustments
  - Less common than settlements or identities
Outcome States:
- PENDING: Awaiting manual review (default state)
  - Item is in the queue waiting for decision
  - Associated entity is on hold
  - Requires action from review team
- MANUAL_REVIEW: Escalated for additional review
  - More complex cases requiring deeper investigation
  - May need legal, compliance, or senior management approval
  - Still blocks the associated entity
- ACCEPTED: Review passed, entity can proceed
  - Settlement will be processed
  - Identity will be activated
  - Fee will be applied
  - completed_at timestamp is set
- REJECTED: Review failed, entity is blocked
  - Settlement will not be processed (funds returned)
  - Identity will not be activated
  - Fee will not be applied
  - outcome_reason contains rejection codes
  - completed_at timestamp is set
Review Types:
- CREATED: Item entered review queue upon creation
  - Example: New settlement flagged by risk rules
- UPDATED: Item entered review queue after modification
  - Example: Identity updated with new information requiring re-review
Outcome Reasons: Array of reason codes (when outcome is REJECTED or MANUAL_REVIEW)
- Common codes:
  - INSUFFICIENT_FUNDS: Not enough balance for settlement
  - RISK_THRESHOLD_EXCEEDED: Transaction exceeds risk limits
  - VELOCITY_LIMIT_EXCEEDED: Too many transactions in timeframe
  - SUSPICIOUS_ACTIVITY: Fraud or AML concerns
  - INCOMPLETE_KYC: Missing identity verification documents
  - SANCTIONS_MATCH: Identity matches sanctions list
  - HIGH_RISK_MERCHANT: Business type or industry flagged
  - CHARGEBACK_RATIO_HIGH: Excessive chargebacks
  - MANUAL_HOLD: Intentional hold for investigation
Filtering Best Practices:
- Filter by outcome=PENDING to get items needing review
- Filter by entity_type to focus on specific review types
- Filter by application_id to review items for specific application
- Use entity_id to check if specific settlement/identity is in review
Use Cases:
- Daily Review Queue: Fetch all PENDING items for manual review
- Settlement Holds: Check which settlements are held in review
- KYC Review Dashboard: List all IDENTITY items needing verification
- Risk Management: Monitor items flagged by risk rules
- Audit Trail: Review historical decisions (ACCEPTED/REJECTED items)
- Alerts: Notify team when new items enter queue
- Metrics: Track review volume and resolution times
Workflow Integration:
1. Item enters review queue (outcome: PENDING)
2. Review team fetches items with this endpoint
3. Team investigates entity (settlement, identity, etc.)
4. Team updates outcome via PUT endpoint (ACCEPTED or REJECTED)
5. System processes entity based on outcome
Pagination: Use limit parameter to control results
- Default: 10 items per page
- Recommended: 20-50 for review dashboards
- Use cursor-based pagination for large queues
Timestamps:
- created_at: When item entered review queue
- updated_at: When outcome or tags were last modified
- completed_at: When review was completed (ACCEPTED/REJECTED)
  - Null for PENDING and MANUAL_REVIEW items
Reviewed By: User who made the decision
- Null for PENDING items (no decision yet)
- Set to User ID when outcome is updated
- Provides accountability and audit trail
Processor Type: Indicates which payment processor is involved
- Relevant for SETTLEMENT_V2 reviews
- Example: LITLE_V1, VANTIV_V1, MASTERCARD_V1
- Helps route reviews to processor-specific teams
Tags: Custom metadata for categorization
- Priority levels (high, medium, low)
- Merchant information
- Risk scores or flags
- Internal notes or references
- Review categories
Performance Considerations:
- Large queues may require pagination
- Filter aggressively to reduce result set
- Cache results for dashboard displays
- Use webhooks for real-time queue updates (if available)
Security and Compliance:
- Review queue access should be restricted to compliance/risk teams
- All decisions are logged with user attribution
- Outcome reasons provide audit trail
- Helps meet regulatory requirements (AML, KYC, fraud prevention)
Related Endpoints:
- GET /review_queue/{id}: Fetch specific item details
- PUT /review_queue/{id}: Update outcome (approve/reject)
- GET /settlements/{id}: View settlement details
- GET /identities/{id}: View identity details
Best Practices:
- Review PENDING items daily to avoid delays
- Document rejection reasons clearly in outcome_reason
- Use tags for internal tracking and categorization
- Monitor queue depth and review times
- Set SLAs for review completion
- Escalate MANUAL_REVIEW items appropriately
- Provide feedback to merchants on rejected items

Overview​

Resource Access​

Arguments​

Example Request (All Pending Items)​

Example Request (Filter by Entity Type)​

Example Response​

Additional Information​