POST v1/Refunds

Documentation for 'Post'.

Request Information

Parameters

NameDescriptionAdditional information
refund 
Documentation for 'refund'.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "reference": "sample string 1",
  "referenceDate": "2024-05-03T13:00:38.8499088+00:00",
  "originalPaymentId": 2,
  "amount": 3.0,
  "refundAllocations": [
    {
      "invoiceId": 1,
      "amount": 2.0
    },
    {
      "invoiceId": 1,
      "amount": 2.0
    },
    {
      "invoiceId": 1,
      "amount": 2.0
    }
  ],
  "method": 0,
  "netsuiteId": "sample string 4"
}

application/xml, text/xml

Sample:
Click to beautify! 
<Refund xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Post">
  <Amount>3</Amount>
  <Method>PaymentMethod</Method>
  <NetsuiteId>sample string 4</NetsuiteId>
  <OriginalPaymentId>2</OriginalPaymentId>
  <Reference>sample string 1</Reference>
  <ReferenceDate>2024-05-03T13:00:38.8499088+00:00</ReferenceDate>
  <RefundAllocations>
    <RefundAllocation>
      <Amount>2</Amount>
      <InvoiceId>1</InvoiceId>
    </RefundAllocation>
    <RefundAllocation>
      <Amount>2</Amount>
      <InvoiceId>1</InvoiceId>
    </RefundAllocation>
    <RefundAllocation>
      <Amount>2</Amount>
      <InvoiceId>1</InvoiceId>
    </RefundAllocation>
  </RefundAllocations>
</Refund>

application/x-www-form-urlencoded

Sample:
Click to beautify!

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "paymentActivityId": 1,
  "reference": "sample string 2",
  "effectiveTimestamp": "2024-05-03T13:00:38.8655553+00:00",
  "referenceDate": "2024-05-03T13:00:38.8655553+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:00:38.8811506+00:00",
    "lastCheckedTimestamp": "2024-05-03T13:00:38.8811506+00:00",
    "nextCheckTimestamp": "2024-05-03T13:00:38.8811506+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.