Documentation | Nedbank API

Nedbank Payments API

9 Initiate Refund

Action

Using your clientID and clientSecret (which you obtained when you created an application), you will make a Post request using the endpoint and values below to create refund request.

To consume this API you will nedd to request API Marketplace team to provide a clientid,clientsecret,certificate.pfx and its passphrase.

Method	POST
Endpoint	https://b2b-api.nedbank.co.za/apimarket/b2b-sb/payments/v1/refunds/initiate-refund

Request

Headers
Header	Value	Description
Accept	application/json	content type
Content-Type	application/json	The content type of the data being sent.
x-idempotency-key	<RANDOM INTEGER>	Random integer. It must be unique for every call
x-ibm-client-id	<YOUR CLIENT ID>	The client ID you received when creating the app on the portal.
x-ibm-client-secret	<YOUR CLIENT SECRET>	The client secret you received when creating the app on the portal.

Body JSON
`{ "Data": { "PaymentID": "REPLACE WITH DOMESTIC PAYMENT ID VALUE FROM SUBMISSION CALL", "RefundIdentifiers": { "EndToEndID": "REPLACE WITH RANDOM UNIQUE STRING", "InstructionIdentification": "REPLACE WITH RANDOM UNIQUE STRING" }, "InterBankSettlementAmount": { "Amount": "1.00", "Currency": "ZAR" }, "RemittanceInformation": { "Unstructured": "abc refund", "CreditorReferenceInfoReference": "abc refund" } } }` The Amount value must be less than or equal to original Amount sent in the consent call.

                                
{
    "Data": {
        "PaymentID": "REPLACE WITH DOMESTIC PAYMENT ID VALUE FROM SUBMISSION CALL",
        "RefundIdentifiers": {
            "EndToEndID": "REPLACE WITH RANDOM UNIQUE STRING",
            "InstructionIdentification": "REPLACE WITH RANDOM UNIQUE STRING"
        },
        "InterBankSettlementAmount": {
            "Amount": "1.00",
            "Currency": "ZAR"
        },
        "RemittanceInformation": {
            "Unstructured": "abc refund",
            "CreditorReferenceInfoReference": "abc refund"
        }
    }
}

The Amount value must be less than or equal to original Amount sent in the consent call.

Response JSON

                            
{
    "Data": {
        "ID": "01HEW1GFDSBEN956Z9RHTF4FY3",
        "PaymentID": "26381573",
        "RequestedDateTime": "2023-11-10T07:21:46.199Z",
        "RefundStatus": "Pending",
        "RefundDetails": {
            "DebtorAccount": {
                "SchemeName": "SortCodeAccountNumber",
                "Identification": "1987651234567890",
                "Name": "ACME Inc"
            },
            "InterBankSettlementAmount": "1.00",
            "Currency": "ZAR",
            "RefundIdentifiers": {
                "EndToEndID": "00016899308543731",
                "InstructionIdentification": "1320134c-56af-4ac1-8c2a-68aa2af67"
            }
        }
    },
    "Links": {
        "Self": "https://b2b-api.nedbank.co.za/apimarket/b2b-sb/payments/v1/refunds/01HEW1GFDSBEN956Z9RHTF4FY3"
    }
}

You now have a ID. Take note of it as you are going to use it in the next call to retrieve the status of the Refund.

Prev step

Next step