CSL Pay Developers
Home / Reference / Collection Refunds

Refund A Collection

POST /collection-middleware/process/refund

This endpoint processes a refund for a collection back to the payer that sent it. A partner would call this endpoint when they wish to initiate a refund for a collection. The request must include the reference transaction ID, reason for the refund, fee policy, and idempotency key.

Request body

  • referenceTransactionIdrequired string
    Unique identifier of the original transaction to be refunded
  • reasonrequired string
    Description of the reason for the refund

Response 200

  • success boolean
    Indicates whether the refund was processed successfully
  • data object17 fields
    Contains the refund details
    • refundReference string
      Unique reference for the refund
    • referenceTransactionId string
      Reference ID of the original transaction
    • status string
      Current status of the refund
    • refundAmount number
      Amount refunded to the payer
    • feeReversedAmount number
      Amount of fees reversed during the refund
    • currencyCode string
      Currency code of the refund
    • payerAccountNumber string
      Payer's account number
    • payerBankCode string
      Payer's bank code
    • payerName string
      Payer's name
    • settlementRoute string
      Route used for settlement
    • feePolicy string
      Fee policy applied to the refund
    • providerReference string
      Provider's reference for the refund
    • providerResponse string
      Provider's response to the refund request
    • reason string
      Reason for the refund
    • failureReason string
      Reason for the refund failure
    • initiatedAt string
      Timestamp when 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