Fetch a Review Queue Item

Overview

Retrieve the details of a specific Review Queue Item by its unique ID. Use this endpoint to examine the complete information about a settlement, identity, or fee awaiting manual review.

Resource Access

User Permissions: Admin users only
Endpoint: GET /review_queue/\{review_queue_item_id}

Arguments

Parameter	Type	Required	Description
review_queue_item_id	string	Yes	The unique ID of the Review Queue Item

Example Request

curl -X GET \
  'https://api.ahrvo.network/payments/na/review_queue/RQreviewQueue123' \
  -u username:password \
  -H 'Content-Type: application/json'

Example Response (Pending Settlement Review)

{
  "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",
    "settlement_amount": "50000",
    "flag_reason": "first_settlement"
  },
  "_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"
    }
  }
}

Example Response (Accepted Identity Review)

{
  "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",
    "documents_verified": "true",
    "reviewer_notes": "All documents verified, low risk"
  },
  "_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"
    }
  }
}

Example Response (Rejected Settlement)

{
  "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",
    "amount": "125000",
    "rejection_details": "Exceeded 30-day volume limit"
  },
  "_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"
    }
  }
}

Additional Information

Entity Types and Their Implications:
- SETTLEMENT_V2: Settlement awaiting approval
  - Settlement is held and won't process until ACCEPTED
  - Merchant won't receive funds while in review
  - Common triggers: Large amounts, first settlement, velocity limits, risk flags
  - Use _links.settlement to view full settlement details
- IDENTITY: Identity/KYC review
  - Identity can't be used until ACCEPTED
  - Blocks merchant onboarding or account updates
  - Common triggers: Incomplete KYC, document verification, sanctions screening
  - Use _links.identity to view full identity details
- FEE: Fee transaction review
  - Fee adjustment or transaction needs approval
  - Less common than settlements or identities
Outcome States:
- PENDING: Awaiting manual review
  - Default state when item enters queue
  - completed_at is null
  - reviewed_by is null
  - Action required: Review and update outcome
- MANUAL_REVIEW: Escalated for additional investigation
  - Requires deeper review or specialized expertise
  - completed_at is null (review ongoing)
  - May have reviewed_by set if assigned
  - Action required: Complete investigation and update outcome
- ACCEPTED: Review passed successfully
  - Entity can proceed (settlement processes, identity activated)
  - completed_at timestamp shows when approved
  - reviewed_by shows who approved
  - No further action needed
- REJECTED: Review failed
  - Entity is blocked (settlement cancelled, identity rejected)
  - outcome_reason contains rejection codes
  - completed_at timestamp shows when rejected
  - reviewed_by shows who rejected
  - May require merchant notification or remediation
Outcome Reasons: Array of standardized codes explaining the decision
- Only populated for REJECTED or MANUAL_REVIEW outcomes
- Common rejection reasons:
  - INSUFFICIENT_FUNDS: Account balance too low
  - RISK_THRESHOLD_EXCEEDED: Transaction exceeds risk limits
  - VELOCITY_LIMIT_EXCEEDED: Too many transactions in period
  - SUSPICIOUS_ACTIVITY: Fraud or AML red flags
  - INCOMPLETE_KYC: Missing required identity documents
  - SANCTIONS_MATCH: Entity matches sanctions/watchlist
  - HIGH_RISK_MERCHANT: Business type or industry flagged
  - CHARGEBACK_RATIO_HIGH: Excessive chargeback rate
  - MANUAL_HOLD: Intentional hold for investigation
  - DOCUMENT_VERIFICATION_FAILED: KYC documents invalid
  - NEGATIVE_DATABASE_MATCH: Match in fraud database
- Use these codes to communicate rejection reasons to merchants
Review Type: Indicates what triggered the review
- CREATED: Entity entered review upon creation
  - Example: New settlement automatically flagged by risk rules
- UPDATED: Entity entered review after modification
  - Example: Identity updated with new information requiring re-review
Processor Type: Payment processor associated with the entity
- Relevant for SETTLEMENT_V2 reviews
- Examples: LITLE_V1, VANTIV_V1, MASTERCARD_V1, DUMMY_V1
- Helps route reviews to processor-specific teams
- Null for non-settlement entities
Reviewed By: User ID of reviewer who made the decision
- Null for PENDING items (no decision yet)
- Set when outcome is updated to ACCEPTED or REJECTED
- Provides accountability and audit trail
- Can link to user details via _links.reviewed_by_user
Timestamps:
- created_at: When item entered the review queue
- updated_at: When outcome, tags, or other fields were last modified
- completed_at: When review was finalized (ACCEPTED or REJECTED)
  - Null for PENDING and ongoing MANUAL_REVIEW items
  - Use to calculate review resolution time
Tags: Custom metadata for tracking and categorization
- Priority levels (high, medium, low)
- Merchant information (name, ID, contact)
- Risk indicators (risk_score, flag_reason)
- Review notes (reviewer_notes, rejection_details)
- Internal references (case_id, ticket_number)
- Settlement amounts or transaction details
- Flexible key-value structure
Use Cases:
- Review Detail Page: Display full context before making decision
- Investigation: Examine entity details before approval/rejection
- Audit Trail: Review historical decisions and reasons
- Escalation: Get details before escalating to MANUAL_REVIEW
- Merchant Communication: Retrieve rejection reasons to share with merchant
- Reporting: Extract review metrics and patterns
- Compliance: Document review process for regulators
Related Resources: Use _links to navigate
- settlement: View the full settlement details (for SETTLEMENT_V2)
- identity: View the full identity details (for IDENTITY)
- application: View the application context
- reviewed_by_user: View details of user who reviewed
Decision Workflow:
1. Fetch review queue item with this endpoint
2. Navigate to linked entity (settlement, identity) for full context
3. Investigate: Check merchant history, transaction patterns, documents
4. Make decision: ACCEPTED, REJECTED, or MANUAL_REVIEW
5. Update outcome via PUT /review_queue/{id}
6. System processes entity based on outcome
Risk Assessment: When reviewing, consider:
- Settlement Reviews:
  - Settlement amount vs merchant history
  - Velocity (transaction frequency and volume)
  - Chargeback rate and reserves
  - Merchant age and reputation
  - Business type and risk category
- Identity Reviews:
  - KYC document completeness and validity
  - Sanctions and watchlist screening
  - Business information accuracy
  - Beneficial ownership verification
  - Regulatory compliance requirements
Response Time: Review queue items should be processed promptly
- PENDING items block business operations
- Settlements on hold prevent merchant payouts
- Identities on hold prevent merchant onboarding
- Set SLAs for review completion (e.g., 24-48 hours)
- Prioritize using tags (priority: high)
Notification: Consider notifying merchants about:
- Items entering review (may delay payout)
- Accepted reviews (payout proceeding)
- Rejected reviews (with clear explanation and remediation steps)
Security and Compliance:
- Access should be restricted to compliance/risk teams
- All actions are logged with user attribution
- Outcome reasons provide audit trail for regulators
- Helps demonstrate AML/KYC compliance
- Documents fraud prevention efforts
Integration Patterns:
- Dashboard: Display review details in review UI
- Webhooks: Get notified when items enter queue (if available)
- Automation: Rules engine to auto-accept low-risk items
- Analytics: Track review patterns and outcomes
- CRM: Link review items to merchant support tickets

Overview​

Resource Access​

Arguments​

Example Request​

Example Response (Pending Settlement Review)​

Example Response (Accepted Identity Review)​

Example Response (Rejected Settlement)​

Additional Information​

Overview

Resource Access

Arguments

Example Request

Example Response (Pending Settlement Review)

Example Response (Accepted Identity Review)

Example Response (Rejected Settlement)

Additional Information