worldline

Documentation

Retrieve a payment

With the Acquiring API, it is possible to get the status of a payment. This would also give you an overview of all the operations performed along with their status and enable you to make the right decision on your next action.

Submit a retrieve payment request using the paymentId of the payment that you would like to get details. Also include the query parameter returnOperations=true to get the complete list of operations performed. Below is the example response for the request (GET /processing/v1/100812/520002526/payments/ pay:ch:etu:HyrtRZfmQ5eG2TmnKgE1zw ? returnOperations=true). You will notice that the response holds the list of operations performed along with its corresponding statuses.

{
    "paymentId": "pay:ch:etu:HyrtRZfmQ5eG2TmnKgE1zw",
    "initialAuthorizationCode": "064516",
    "cardPaymentData": {
        "brand": "VISA"
    },
    "references": {
        "schemeTransactionId": "304288324051054",
        "paymentAccountReference": "V0010013021193565286838335064"
    },
    "status": "CONFIRMED",
    "operations": [
        {
            "operationId": "95f662b3-59cd-4e70-aec7-6c6ce75ba606",
            "operationType": "CAPTURE",
            "operationTimestamp": "2024-10-14T09:01:27.392Z",
            "amount": {
                "amount": 35000,
                "currencyCode": "EUR",
                "numberOfDecimals": 2
            },
            "responseCode": "0",
            "responseCodeDescription": "Accepted or completed successfully",
            "responseCodeCategory": "APPROVED"
        },
        {
            "operationId": "6363cb33-a7b3-434e-83ac-44ebe76ceee7",
            "operationType": "CAPTURE",
            "operationTimestamp": "2024-10-14T09:01:11.532Z",
            "amount": {
                "amount": 35000,
                "currencyCode": "EUR",
                "numberOfDecimals": 2
            },
            "responseCode": "0",
            "responseCodeDescription": "Accepted or completed successfully",
            "responseCodeCategory": "APPROVED"
        },
        {
            "operationId": "eee74e6f-b38e-44ea-ba84-94155559dd1c",
            "operationType": "INCREMENT",
            "operationTimestamp": "2024-10-14T09:00:47.797Z",
            "amount": {
                "amount": 5000,
                "currencyCode": "EUR",
                "numberOfDecimals": 2
            },
            "responseCode": "0",
            "responseCodeDescription": "Accepted or completed successfully",
            "responseCodeCategory": "APPROVED",
            "authorizationCode": "064516"
        },
        {
            "operationId": "f5c7156d-9596-401b-832e-87d018726179",
            "operationType": "INCREMENT",
            "operationTimestamp": "2024-10-14T09:00:15.65Z",
            "amount": {
                "amount": 5000,
                "currencyCode": "EUR",
                "numberOfDecimals": 2
            },
            "responseCode": "0",
            "responseCodeDescription": "Accepted or completed successfully",
            "responseCodeCategory": "APPROVED",
            "authorizationCode": "082763"
        },
        {
            "operationId": "0d6288f5-a345-42ec-9da9-c4c8078eedde",
            "operationType": "AUTHORIZATION",
            "operationTimestamp": "2024-10-14T09:00:05.099Z",
            "amount": {
                "amount": 60000,
                "currencyCode": "EUR",
                "numberOfDecimals": 2
            },
            "responseCode": "0",
            "responseCodeDescription": "Accepted or completed successfully",
            "responseCodeCategory": "APPROVED",
            "authorizationCode": "064516"
        }
    ]
}

Please refer to response handling to understand the response properties and decide on the next course of action on your platform.