GET v1/Refunds/{id}

Documentation for 'Get'.

Request Information

Parameters

NameDescriptionAdditional information
id 
Documentation for 'id'.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "paymentActivityId": 1,
  "reference": "sample string 2",
  "effectiveTimestamp": "2024-05-03T13:36:12.1767302+00:00",
  "referenceDate": "2024-05-03T13:36:12.1767302+00:00",
  "description": "sample string 4",
  "customerId": 5,
  "originalPaymentActivityId": 1,
  "amount": 6.0,
  "currency": "sample string 7",
  "invoiceAllocations": [
    {
      "invoiceId": 1,
      "invoiceNumber": 2,
      "amount": 3.0,
      "outstandingBalance": 4.0,
      "invoiceTotal": 5.0,
      "surchargingFee": 1.0,
      "poNumber": "sample string 6",
      "netsuiteId": "sample string 7",
      "quickbooksId": 1,
      "invoiceNote": "sample string 8",
      "uri": "sample string 9"
    },
    {
      "invoiceId": 1,
      "invoiceNumber": 2,
      "amount": 3.0,
      "outstandingBalance": 4.0,
      "invoiceTotal": 5.0,
      "surchargingFee": 1.0,
      "poNumber": "sample string 6",
      "netsuiteId": "sample string 7",
      "quickbooksId": 1,
      "invoiceNote": "sample string 8",
      "uri": "sample string 9"
    },
    {
      "invoiceId": 1,
      "invoiceNumber": 2,
      "amount": 3.0,
      "outstandingBalance": 4.0,
      "invoiceTotal": 5.0,
      "surchargingFee": 1.0,
      "poNumber": "sample string 6",
      "netsuiteId": "sample string 7",
      "quickbooksId": 1,
      "invoiceNote": "sample string 8",
      "uri": "sample string 9"
    }
  ],
  "refunds": [],
  "unallocatedAmount": 8.0,
  "refundableAmount": 1.0,
  "gatewayFee": 1.0,
  "settlement": {
    "status": "sample string 1",
    "modifiedTimestamp": "2024-05-03T13:36:12.1924141+00:00",
    "lastCheckedTimestamp": "2024-05-03T13:36:12.1924141+00:00",
    "nextCheckTimestamp": "2024-05-03T13:36:12.1924141+00:00",
    "message": "sample string 2"
  },
  "netsuiteId": "sample string 9",
  "surchargingFee": 1.0,
  "sendToNetsuite": true,
  "quickBooksId": 1,
  "quickBooksAttemptNumber": 11,
  "id": 12,
  "uri": "sample string 13"
}

application/xml

Sample:
Click to beautify!

Sample not available.

text/xml

Sample:
Click to beautify!

Sample not available.