List all Entries in a Settlement

Overview

Retrieve an exhaustive list of every Settlement Entry (Transfers, Fees, Split Transfers, Reversals) included in a Settlement. Use this endpoint to see the detailed breakdown of all financial activities that make up the settlement total.

Resource Access

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

Arguments

Parameter	Type	Required	Description
settlement_id	string	Yes (path)	The unique ID of the Settlement
limit	integer	No	Maximum number of records to return (default: 10)

Example Request

curl -X GET \
  'https://api.ahrvo.network/payments/na/settlements/STsettlementExample123/entries?limit=50' \
  -u username:password \
  -H 'Content-Type: application/json'

Example Response

{
  "_embedded": {
    "settlement_entries": [
      {
        "id": "SEsettlementEntry001",
        "created_at": "2023-12-10T10:30:00Z",
        "amount": 5000,
        "currency": "USD",
        "entity_id": "TRtransferExample123",
        "entity_type": "TRANSFER",
        "subtype": "DEBIT",
        "ready_to_settle_at": "2023-12-10T10:30:00Z",
        "should_fund": true,
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/settlement_entries/SEsettlementEntry001"
          },
          "transfer": {
            "href": "https://api.ahrvo.network/payments/na/transfers/TRtransferExample123"
          }
        }
      },
      {
        "id": "SEsettlementEntry002",
        "created_at": "2023-12-10T11:15:00Z",
        "amount": 3000,
        "currency": "USD",
        "entity_id": "TRtransferExample456",
        "entity_type": "TRANSFER",
        "subtype": "DEBIT",
        "ready_to_settle_at": "2023-12-10T11:15:00Z",
        "should_fund": true,
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/settlement_entries/SEsettlementEntry002"
          },
          "transfer": {
            "href": "https://api.ahrvo.network/payments/na/transfers/TRtransferExample456"
          }
        }
      },
      {
        "id": "SEsettlementEntry003",
        "created_at": "2023-12-10T14:20:00Z",
        "amount": 2000,
        "currency": "USD",
        "entity_id": "TRtransferExample789",
        "entity_type": "TRANSFER",
        "subtype": "DEBIT",
        "ready_to_settle_at": "2023-12-10T14:20:00Z",
        "should_fund": true,
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/settlement_entries/SEsettlementEntry003"
          },
          "transfer": {
            "href": "https://api.ahrvo.network/payments/na/transfers/TRtransferExample789"
          }
        }
      },
      {
        "id": "SEsettlementEntry004",
        "created_at": "2023-12-10T10:30:00Z",
        "amount": -150,
        "currency": "USD",
        "entity_id": "FEfeeExample111",
        "entity_type": "FEE",
        "subtype": "FEE",
        "ready_to_settle_at": "2023-12-10T10:30:00Z",
        "should_fund": false,
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/settlement_entries/SEsettlementEntry004"
          },
          "fee": {
            "href": "https://api.ahrvo.network/payments/na/fees/FEfeeExample111"
          }
        }
      },
      {
        "id": "SEsettlementEntry005",
        "created_at": "2023-12-10T16:00:00Z",
        "amount": -500,
        "currency": "USD",
        "entity_id": "RVreversalExample222",
        "entity_type": "REVERSAL",
        "subtype": "CREDIT",
        "ready_to_settle_at": "2023-12-10T16:00:00Z",
        "should_fund": true,
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/settlement_entries/SEsettlementEntry005"
          },
          "reversal": {
            "href": "https://api.ahrvo.network/payments/na/reversals/RVreversalExample222"
          }
        }
      }
    ]
  },
  "page": {
    "offset": 0,
    "limit": 50,
    "count": 5
  },
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/settlements/STsettlementExample123/entries?limit=50"
    },
    "settlement": {
      "href": "https://api.ahrvo.network/payments/na/settlements/STsettlementExample123"
    }
  }
}

Additional Information

• Entity Types in Settlement:
  • TRANSFER: Payment transactions
    • Positive amounts (DEBIT): Merchant received payment from customer
    • Negative amounts (CREDIT): Refund to customer
  • FEE: Platform and processing fees
    • Always negative (deducted from merchant payout)
    • Examples: Transaction fees, monthly fees, chargeback fees
  • REVERSAL: Chargebacks, disputes, or corrections
    • Typically negative (funds returned to customer/platform)
• Subtypes:
  • DEBIT: Merchant receives funds (positive)
  • CREDIT: Merchant pays/returns funds (negative)
  • FEE: Fee charged to merchant (negative)
• Should Fund: Indicates if entry affects payout
  • true: Included in funding transfer to merchant
  • false: Fees or adjustments not directly funded
• Amount Field:
  • Positive: Adds to merchant payout (revenue)
  • Negative: Reduces merchant payout (fees, refunds)
  • In cents (smallest currency unit)
• Calculating Settlement Total:
  • Sum all entry amounts = net_amount in settlement
  • Example from above:
    • Transfers: +5000 + 3000 + 2000 = 10,000
    • Fees: -150
    • Reversals: -500
    • Total: 10,000 - 150 - 500 = 9,350 cents ($93.50)
• Use Cases:
  • Reconciliation: Match settlement total to individual transactions
  • Dispute Resolution: Show merchant exact breakdown
  • Accounting: Export detailed transaction list
  • Audit: Verify all transactions properly included
  • Customer Support: Explain settlement amount to merchant
• Pagination: Use limit parameter for large settlements
  • High-volume merchants may have thousands of entries
  • Increase limit or use cursor pagination
• Related Endpoints:
  • GET /transfers/{entity_id}: View transfer details
  • GET /fees/{entity_id}: View fee details
  • DELETE /settlements/{id}/entries: Remove entries before funding