GET json/Transaction/RefundInfo/{transactionKey}

This returns the refund info

Request Information

URI Parameters

Name	Description	Type	Additional information
transactionKey		string	Required

Body Parameters

None.

Response Information

Resource Description

RefundInfoResponseRefundInfo

Name	Type	Additional information
TransactionKey	string	None.
IsRefundable	boolean	None.
NotRefundableExplanation	string	None.
AllowPartialRefund	boolean	None.
MaximumRefundAmount	decimal number	None.
PendingRefundAmount	decimal number	None.
RefundedAmount	decimal number	None.
RefundCurrency	string	None.
ServiceCode	string	None.
RefundInputFields	Collection of RefundInputField	None.
IsCreditmanagement	boolean	None.
Invoice	string	None.
InvoiceAmount	decimal number	None.
InvoiceAmountPaid	decimal number	None.
InvoiceAmountOpen	decimal number	None.
CanCreateCreditNote	boolean	None.
CreditNoteAmount	decimal number	None.
CanBeCancelled	boolean	None.
UsesBalance	boolean	None.
AdditionalMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "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"
}

text/html

Sample:

{"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"}