worldline

Documentation

Retrieve a refund

With the Acquiring API, it is possible to get the status of a refund irrespective of whether it is a referenced refund or standalone refund. This would also give you an overview of all the operations performed.

Submit a retrieve refund request using the refundId along with a query parameter returnOperations=true to get the complete list of operations performed. Below is the response for the example request (GET /processing/v1/100812/520002526/refunds/ pay:ch:etu:YzVw1KOzRnenfPkWLbJLFA ? returnOperations=true). You will notice that the response holds the list of operations performed along with its corresponding status.

{
    "refundId": "pay:ch:etu:YzVw1KOzRnenfPkWLbJLFA",
    "initialAuthorizationCode": "213471",
    "cardPaymentData": {
        "brand": "VISA"
    },
    "references": {
        "schemeTransactionId": "304288324055434",
        "paymentAccountReference": "V0010013021193565286838335064"
    },
    "status": "CONFIRMED",
    "operations": [
        {
            "operationId": "4f454791-5b66-4fb0-aea9-9e8519b8405e",
            "operationType": "CAPTURE",
            "operationTimestamp": "2024-10-14T09:23:59.415Z",
            "amount": {
                "amount": 2100,
                "currencyCode": "EUR",
                "numberOfDecimals": 2
            },
            "responseCode": "0",
            "responseCodeDescription": "Accepted or completed successfully",
            "responseCodeCategory": "APPROVED"
        },
        {
            "operationId": "c90ab5bf-e807-424f-a029-6326c2d8a73f",
            "operationType": "AUTHORIZATION",
            "operationTimestamp": "2024-10-14T09:23:47.963Z",
            "amount": {
                "amount": 2100,
                "currencyCode": "EUR",
                "numberOfDecimals": 2
            },
            "responseCode": "0",
            "responseCodeDescription": "Accepted or completed successfully",
            "responseCodeCategory": "APPROVED"
        }
    ]
}

Please refer to response handling to understand the response code, category, responder and status to decide on the next course of action on your platform.