CSL Pay Developers
Home / Reference / Collection Refunds

Fetch A Refund By Reference

GET /collection-middleware/fetch/{refundReference}

This endpoint fetches a refund by its reference, allowing a partner to retrieve the details of a specific refund. A partner would call this endpoint when they need to access the status and details of a refund that has been processed through the CSL Pay platform. The endpoint returns the refund details in a structured format.

Path parameters

  • refundReferencerequired string

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

  • success boolean
    Indicates whether the refund request was successful
  • data object17 fields
    The refund data object
    • refundReference string
      The unique reference for the refund
    • referenceTransactionId string
      The reference ID of the original transaction
    • status string
      The current status of the refund
    • refundAmount number
      The amount refunded to the payer
    • feeReversedAmount number
      The amount of fees reversed
    • currencyCode string
      The currency code of the refund
    • payerAccountNumber string
      The account number of the payer
    • payerBankCode string
      The bank code of the payer
    • payerName string
      The name of the payer
    • settlementRoute string
      The route used for settlement
    • feePolicy string
      The fee policy applied to the refund
    • providerReference string
      The reference ID from the payment provider
    • providerResponse string
      The response from the payment provider
    • reason string
      The reason for the refund
    • failureReason string
      The reason for the refund failure
    • initiatedAt string
      The date and time the refund was initiated
    • completedAt string
      The timestamp the reversal was completed
  • error object2 fields
    • code string
      The error code as returned from the bank
    • message string
      The error message returned from the bank