Refund Info (POST)

      Refund Info (POST)


        Article Summary

        POST
        Live: https://checkout.buckaroo.nl/json/Transaction/RefundInfos
        Test: https://testcheckout.buckaroo.nl/json/Transaction/RefundInfos

        This returns the refund info(s)

        The authentication of this JSON API is based on a standard HMAC Authentication implementation.

        Request information

        URI Parameters

        None.

        Body Parameters

        NameTypeDescription
        RefundInfoCollectionCollection of RefundInfoRequestRefundInfo

        Request formats

        {
          "RefundInfoCollection": [
            {
              "TransactionKey": "sample string 1"
            },
            {
              "TransactionKey": "sample string 1"
            }
          ]
        }
        

        Response information

        RefundInfoResponse

        NameTypeDescription
        RefundInfoCollectionCollection of RefundInfoResponseRefundInfo
        InvalidRefundInfoCollectionCollection of InvalidRefundInfo

        Request formats

        {
          "RefundInfoCollection": [
            {
              "TransactionKey": "sample string 1",
              "IsRefundable": true,
              "NotRefundableExplanation": "sample string 3",
              "AllowPartialRefund": true,
              "MaximumRefundAmount": 5.0,
              "PendingRefundAmount": 6.0,
              "RefundedAmount": 7.0,
              "RefundCurrency": "sample string 8",
              "ServiceCode": "sample string 9",
              "RefundInputFields": [
                {
                  "FieldDefinition": {
                    "ListItemDescriptions": [
                      {
                        "Value": "sample string 1",
                        "Description": "sample string 1",
                        "GroupName": "sample string 2"
                      },
                      {
                        "Value": "sample string 1",
                        "Description": "sample string 1",
                        "GroupName": "sample string 2"
                      }
                    ],
                    "isRequestParameter": true,
                    "Name": "sample string 1",
                    "DataType": 0,
                    "MaxLength": 2,
                    "MaxOccurs": 3,
                    "Required": true,
                    "Global": true,
                    "Group": "sample string 6",
                    "Description": "sample string 7",
                    "ExplanationHTML": "sample string 8",
                    "DisplayName": "sample string 9",
                    "InputPattern": "sample string 10",
                    "AutoCompleteType": "sample string 11"
                  },
                  "CurrentValue": "sample string 1",
                  "CurrentValueIncorrect": true,
                  "CurrentValueEditable": true
                },
                {
                  "FieldDefinition": {
                    "ListItemDescriptions": [
                      {
                        "Value": "sample string 1",
                        "Description": "sample string 1",
                        "GroupName": "sample string 2"
                      },
                      {
                        "Value": "sample string 1",
                        "Description": "sample string 1",
                        "GroupName": "sample string 2"
                      }
                    ],
                    "isRequestParameter": true,
                    "Name": "sample string 1",
                    "DataType": 0,
                    "MaxLength": 2,
                    "MaxOccurs": 3,
                    "Required": true,
                    "Global": true,
                    "Group": "sample string 6",
                    "Description": "sample string 7",
                    "ExplanationHTML": "sample string 8",
                    "DisplayName": "sample string 9",
                    "InputPattern": "sample string 10",
                    "AutoCompleteType": "sample string 11"
                  },
                  "CurrentValue": "sample string 1",
                  "CurrentValueIncorrect": true,
                  "CurrentValueEditable": true
                }
              ],
              "IsCreditmanagement": true,
              "Invoice": "sample string 11",
              "InvoiceAmount": 12.0,
              "InvoiceAmountPaid": 13.0,
              "InvoiceAmountOpen": 14.0,
              "CanCreateCreditNote": true,
              "CreditNoteAmount": 16.0,
              "CanBeCancelled": true,
              "UsesBalance": true,
              "AdditionalMessage": "sample string 19"
            },
            {
              "TransactionKey": "sample string 1",
              "IsRefundable": true,
              "NotRefundableExplanation": "sample string 3",
              "AllowPartialRefund": true,
              "MaximumRefundAmount": 5.0,
              "PendingRefundAmount": 6.0,
              "RefundedAmount": 7.0,
              "RefundCurrency": "sample string 8",
              "ServiceCode": "sample string 9",
              "RefundInputFields": [
                {
                  "FieldDefinition": {
                    "ListItemDescriptions": [
                      {
                        "Value": "sample string 1",
                        "Description": "sample string 1",
                        "GroupName": "sample string 2"
                      },
                      {
                        "Value": "sample string 1",
                        "Description": "sample string 1",
                        "GroupName": "sample string 2"
                      }
                    ],
                    "isRequestParameter": true,
                    "Name": "sample string 1",
                    "DataType": 0,
                    "MaxLength": 2,
                    "MaxOccurs": 3,
                    "Required": true,
                    "Global": true,
                    "Group": "sample string 6",
                    "Description": "sample string 7",
                    "ExplanationHTML": "sample string 8",
                    "DisplayName": "sample string 9",
                    "InputPattern": "sample string 10",
                    "AutoCompleteType": "sample string 11"
                  },
                  "CurrentValue": "sample string 1",
                  "CurrentValueIncorrect": true,
                  "CurrentValueEditable": true
                },
                {
                  "FieldDefinition": {
                    "ListItemDescriptions": [
                      {
                        "Value": "sample string 1",
                        "Description": "sample string 1",
                        "GroupName": "sample string 2"
                      },
                      {
                        "Value": "sample string 1",
                        "Description": "sample string 1",
                        "GroupName": "sample string 2"
                      }
                    ],
                    "isRequestParameter": true,
                    "Name": "sample string 1",
                    "DataType": 0,
                    "MaxLength": 2,
                    "MaxOccurs": 3,
                    "Required": true,
                    "Global": true,
                    "Group": "sample string 6",
                    "Description": "sample string 7",
                    "ExplanationHTML": "sample string 8",
                    "DisplayName": "sample string 9",
                    "InputPattern": "sample string 10",
                    "AutoCompleteType": "sample string 11"
                  },
                  "CurrentValue": "sample string 1",
                  "CurrentValueIncorrect": true,
                  "CurrentValueEditable": true
                }
              ],
              "IsCreditmanagement": true,
              "Invoice": "sample string 11",
              "InvoiceAmount": 12.0,
              "InvoiceAmountPaid": 13.0,
              "InvoiceAmountOpen": 14.0,
              "CanCreateCreditNote": true,
              "CreditNoteAmount": 16.0,
              "CanBeCancelled": true,
              "UsesBalance": true,
              "AdditionalMessage": "sample string 19"
            }
          ],
          "InvalidRefundInfoCollection": [
            {
              "ErrorMessage": "sample string 1",
              "TransactionKey": "sample string 1"
            },
            {
              "ErrorMessage": "sample string 1",
              "TransactionKey": "sample string 1"
            }
          ]
        }
        

        Was this article helpful?