Refund action

      Refund action


        Article Summary

        Base JSON request

        Use the base request as instructed on this page

        Refund

        Use the parameter Amount_Credit to specify the refund amount and Originaltransaction to refer to the payment transaction.

        Refund request with articles

        {
            "Currency": "EUR",
            "AmountCredit": 10.00,
            "Invoice": "Ref.1 OrderID Refund",
            "OriginalTransactionKey": "855CFD51867241FCAB5E23ADB49C1C3E",
            "Services": {
                "ServiceList": [
                    {
                        "Name": "klarnakp",
                        "Action": "Refund",
                        "Parameters": [
                            {
                                "Name": "ArticleNumber",
                                "GroupType": "Article",
                                "GroupID": "1",
                                "Value": "12345"
                            },
                            {
                                "Name": "ArticleQuantity",
                                "GroupType": "Article",
                                "GroupID": "1",
                                "Value": "1"
                            }
                        ]
                    }
                ]
            }
        }
        

        Refund request amount based

        {
            "Currency": "EUR",
            "AmountCredit": 12.45,
            "Invoice": "Ref.1 OrderID Refund",
            "OriginalTransactionKey": "3CB70527A86E4111BC72CC87A0D459DA",
            "Services": {
                "ServiceList": [
                    {
                        "Name": "klarnakp",
                        "Action": "Refund"
                       
                    }
                ]
            }
        }
        

        Request parameters

        ParameterTypeOCMDescription
        OriginalTransactionKeystringMBuckaroo reference to the Capture at Klarna

        Refund response

        {
            "Key": "90E42A6B29AE4C688D732E4860E43EA1",
            "Status": {
                "Code": {
                    "Code": 190,
                    "Description": "Success"
                },
                "SubCode": {
                    "Code": "S990",
                    "Description": "The request was successful."
                },
                "DateTime": "2023-03-27T14:22:19"
            },
            "RequiredAction": null,
            "Services": [
                {
                    "Name": "KlarnaKp",
                    "Action": null,
                    "Parameters": [
                        {
                            "Name": "Processsed",
                            "Value": "Classic"
                        }
                    ]
                }
            ],
            "CustomParameters": null,
            "AdditionalParameters": null,
            "RequestErrors": null,
            "Invoice": "Ref.1 OrderID Refund",
            "ServiceCode": "KlarnaKp",
            "IsTest": true,
            "Currency": "EUR",
            "AmountCredit": 1.00,
            "TransactionType": "C118",
            "MutationType": 1,
            "RelatedTransactions": [
                {
                    "RelationType": "refund",
                    "RelatedTransactionKey": "058ABA06A4A24840AB6B77FA5689CAF2"
                }
            ],
            "ConsumerMessage": null,
            "Order": null,
            "IssuingCountry": null,
            "StartRecurrent": false,
            "Recurring": false,
            "CustomerName": null,
            "PayerHash": null,
            "PaymentKey": "82A67C9BBF53406685F1C67F44DFA20E"
        }
        

        Refund push

        {
          "Transaction": {
            "Key": "2E17CA6D80DE4AA09F4DB9DF45F637D6",
            "Invoice": "Ref.1 OrderID Refund",
            "ServiceCode": "KlarnaKp",
            "Status": {
              "Code": {
                "Code": 190,
                "Description": "Success"
              },
              "SubCode": {
                "Code": "S990",
                "Description": "The request was successful."
              },
              "DateTime": "2023-03-27T14:24:55"
            },
            "IsTest": true,
            "Order": null,
            "Currency": "EUR",
            "AmountCredit": 1,
            "TransactionType": "C118",
            "Services": [
              {
                "Name": "KlarnaKp",
                "Action": null,
                "Parameters": [
                  {
                    "Name": "Processsed",
                    "Value": "Classic"
                  }
                ],
                "VersionAsProperty": 1
              }
            ],
            "CustomParameters": null,
            "AdditionalParameters": null,
            "MutationType": 1,
            "RelatedTransactions": [
              {
                "RelationType": "refund",
                "RelatedTransactionKey": "058ABA06A4A24840AB6B77FA5689CAF2"
              }
            ],
            "IsCancelable": false,
            "IssuingCountry": null,
            "StartRecurrent": false,
            "Recurring": false,
            "CustomerName": null,
            "PayerHash": null,
            "PaymentKey": "143C6BD82B63401EA5248A17C4CA92EB",
            "Description": null
          }
        }
        
        

        Push Parameters

        ParameterTypeOCMDescription
        ServiceCodestringMKlarna serivce label is KlarnaKp
        CodestringMContains the status of the transaction
        TransactionTypeStringM
        IsTestbooleanMIf their is actual funds processed
        RelatedTransactionKeyStringOcontains Pay Transaction Key of Buckaroo

        Was this article helpful?

        What's Next