CSL Pay Developers
Home / Reference / Collection Refunds

List Refunds By Merchant

GET /collection-middleware/list/refunds

The List Refunds By Merchant endpoint retrieves a list of refunds associated with a merchant's account. A partner would call this endpoint to retrieve refund information for a specific merchant. The endpoint returns a list of refunds, including their reference, status, amount, and associated payer details.

Query parameters

  • page integer
  • size integer

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

  • success boolean
    Indicates whether the request was successful
  • data array17 fields
    Array of refund objects
    • refundReference string
      Unique reference for the refund
    • referenceTransactionId string
      Reference to the original transaction
    • status string
      Current status of the refund
    • refundAmount number
      Amount refunded to the payer
    • feeReversedAmount number
      Amount of fees reversed
    • currencyCode string
      Currency code of the refund
    • payerAccountNumber string
      Account number of the payer
    • payerBankCode string
      Bank code of the payer
    • payerName string
      Name of the payer
    • settlementRoute string
      Route used for settlement
    • feePolicy string
      Policy applied to the refund
    • providerReference string
      Reference from the payment provider
    • providerResponse string
      Response from the payment provider
    • reason string
      Reason for the refund
    • failureReason string
      Reason for the refund failure
    • initiatedAt string
      Date and time the refund was initiated
    • completedAt string
  • error object2 fields
    • code string
      The error code returned by the bank
    • message string
      The error message returned by the bank