Skip to main content

Delete Settlement Entries

Overview​

Remove one or more Settlement Entries from a Settlement before it is funded. Use this endpoint to exclude specific transactions, fees, or reversals from a settlement that hasn't been approved yet.

Resource Access​

  • User Permissions: Admin users only
  • Endpoint: DELETE /settlements/\{settlement_id}/entries

Arguments​

ParameterTypeRequiredDescription
settlement_idstringYes (path)The unique ID of the Settlement
settlement_entry_idsarrayYesArray of Settlement Entry IDs to remove

Example Request​

curl -X DELETE \
  'https://api.ahrvo.network/payments/na/settlements/STsettlementExample123/entries' \
  -u username:password \
  -H 'Content-Type: application/json' \
  -d '{
    "settlement_entry_ids": [
      "SEsettlementEntry001",
      "SEsettlementEntry002"
    ]
  }'

Example Response​

HTTP/1.1 204 No Content

Additional Information​

  • HTTP 204 Response: Success returns 204 No Content
    • No response body
    • Entries have been removed from settlement
    • Settlement amounts (total_amount, total_fee, net_amount) will be recalculated
  • Settlement Must Not Be Approved: Can only delete from PENDING or AWAITING_APPROVAL settlements
    • Cannot modify APPROVED settlements (already funded)
    • Error if attempting to delete from approved settlement
  • When to Use:
    • Error Correction: Remove transaction added by mistake
    • Dispute Handling: Exclude disputed transaction from settlement
    • Fraud Prevention: Remove suspicious transaction before payout
    • Manual Adjustments: Fine-tune settlement content
    • Testing: Remove test transactions from settlement
  • Effect on Settlement:
    • Removed entries excluded from settlement total
    • Settlement amounts recalculated automatically
    • Entries may be included in next settlement (if still in queue)
    • Or may need to be manually re-added later
  • Use Cases:

    • Remove Fraudulent Transaction:

      1. Fraud detected after transaction in settlement
      2. List settlement entries to find transaction
      3. Delete entry before settlement approved
      4. Prevent payout of fraudulent funds
      5. Handle reversal separately

    • Exclude Disputed Amount:

      1. Customer disputes charge
      2. Transaction already in settlement
      3. Remove from settlement while investigating
      4. Process settlement without disputed amount
      5. Add back if dispute resolves in merchant's favor

    • Correct Processing Error:

      1. Transaction incorrectly included
      2. Should be in different settlement or excluded
      3. Delete from current settlement
      4. Transaction handled appropriately
  • Best Practices:
    • Verify settlement status before deleting (must be PENDING/AWAITING_APPROVAL)
    • Document reason for removal
    • Track removed entries for reconciliation
    • Communicate with merchant if significant amounts removed
    • Monitor settlement amounts after deletion
  • Alternatives:
    • For TRANSFER entities: Can also use deprecated DELETE /settlements/{id}/funding_transfers
    • Better to use this endpoint (supports all entity types)
  • Related Endpoints:
    • GET /settlements/{id}/entries: List entries to find IDs
    • GET /settlements/{id}: Check settlement status and amounts after deletion