CancelReservation action

      CancelReservation action


        Article Summary

        Basic parameters

        CancelReservation Request

        The CancelReservation action can be used in two scenario's

        1. There has been no partial capture, a cancel will close the full order.
        2. There has been a partial capture, a cancel will close the remaining amount and products still part of the reservation

        General CancelReservation request

        {
           "Currency": "EUR",
           "Services": {
              "ServiceList": [
                 {
                    "Name": "klarnakp",
                    "Action": "CancelReservation",
                    "Parameters": [
                       {
                          "Name": "ReservationNumber",
                          "Value": "11ab9249-95c7-41e8-86fa-0a60030d9eef"
                       }
                    ]
                 }
              ]
           }
        }
        
        

        Request Parameters

        ParameterTypeOCMDescription
        ReservationNumberstringMKlarna order ID

        CancelReservation response

        {
            "Key": "D24D08A03A2944B9AD9F3723483C5161",
            "Status": {
                "Code": {
                    "Code": 190,
                    "Description": "Success"
                },
                "SubCode": {
                    "Code": "S990",
                    "Description": "The request was successful."
                },
                "DateTime": "2023-03-27T08:45:24"
            },
            "RequiredAction": null,
            "Services": null,
            "CustomParameters": null,
            "AdditionalParameters": null,
            "RequestErrors": null,
            "ServiceCode": "KlarnaKp",
            "IsTest": true,
            "ConsumerMessage": null
        }
        

        Response Parameters

        ParameterTypeOCMDescription
        ServiceCodestringMKlarna serivce label is KlarnaKp
        CodestringMContains the status of the CancelReservation not the Reservation
        IsTestbooleanMIf their is actual funds processed

        CancelReservation push

        {
          "DataRequest": {
            "Key": "446F21147A2F4415967A2CF393714141",
            "Invoice": null,
            "ServiceCode": "KlarnaKp",
            "ActionCode": "CancelReservation",
            "Status": {
              "Code": {
                "Code": 190,
                "Description": "The request was successful."
              },
              "SubCode": null,
              "DateTime": "2023-03-27T08:54:17"
            },
            "IsTest": true,
            "Order": null,
            "Currency": "EUR",
            "AmountDebit": 0,
            "Services": null,
            "CustomParameters": null,
            "AdditionalParameters": null,
            "MutationType": 0,
            "IssuingCountry": null,
            "StartRecurrent": false,
            "Recurring": false,
            "CustomerName": null,
            "PayerHash": null,
            "PaymentKey": null
          }
        }
        

        Push Parameters

        ParameterTypeOCMDescription
        ServiceCodestringMKlarna serivce label is KlarnaKp
        CodestringMContains the status of the Cancellation not the Reservation
        IsTestbooleanMIf their is actual funds processed

        Was this article helpful?