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

Name	Type	Description
refundReferencerequired	string	—

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

Field	Type	Description
success	boolean	—
data	object	—
refundReference	string	—
referenceTransactionId	string	—
status	string	—
refundAmount	number	—
feeReversedAmount	number	—
currencyCode	string	—
payerAccountNumber	string	—
payerBankCode	string	—
payerName	string	—
settlementRoute	string	—
feePolicy	string	—
providerReference	string	—
providerResponse	string	—
reason	string	—
failureReason	string	—
initiatedAt	string	—
completedAt	string	—
error	object	—
code	string	—
message	string	—

Environment

Request

curl -X GET "https://api.dev.cslpay.io/collection-middleware/fetch/{refundReference}" \
  -H "Authorization: Bearer <access-token>"

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
        .url("https://api.dev.cslpay.io/collection-middleware/fetch/{refundReference}")
        .get()
        .addHeader("Authorization", "Bearer <access-token>")
        .build();

try (Response response = client.newCall(request).execute()) {
    if (!response.isSuccessful()) {
        throw new IOException("Unexpected status " + response.code());
    }
    System.out.println(response.body().string());
}

const response = await fetch("https://api.dev.cslpay.io/collection-middleware/fetch/{refundReference}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <access-token>"
  }
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://api.dev.cslpay.io/collection-middleware/fetch/{refundReference}",
    headers={
        "Authorization": "Bearer <access-token>"
    },
)

response.raise_for_status()
print(response.json())

Response

200OK

{
  "success": true,
  "data": {
    "refundReference": "string",
    "referenceTransactionId": "string",
    "status": "PENDING",
    "refundAmount": 0,
    "feeReversedAmount": 0,
    "currencyCode": "string",
    "payerAccountNumber": "string",
    "payerBankCode": "string",
    "payerName": "string",
    "settlementRoute": "EXTERNAL",
    "feePolicy": "REVERSE_FEE",
    "providerReference": "string",
    "providerResponse": "string",
    "reason": "string",
    "failureReason": "string",
    "initiatedAt": "2026-01-15T09:30:00Z",
    "completedAt": "2026-01-15T09:30:00Z"
  },
  "error": {
    "code": "string",
    "message": "string"
  }
}

Authorization

Authorization: Bearer <access-token>

Sent on every request. See Getting Started.