Skip to main content
POST
/
api
/
Invoices
/
{invoiceId}
/
refund
Refund Invoice
curl --request POST \
  --url https://api-sandbox.revolv3.com/api/Invoices/{invoiceId}/refund \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-revolv3-token: <api-key>' \
  --data '
{
  "amount": 5,
  "includeRawProcessorResponse": false,
  "reportGroup": null
}
'
{
  "invoice": {
    "invoiceId": 2,
    "parentInvoiceId": 1,
    "customerId": 1,
    "merchantInvoiceRefId": "ca552d9a-637c-49c5-b870-179be6e99e8d",
    "paymentMethod": {
      "paymentMethodId": 1,
      "billingAddressId": 1,
      "billingFirstName": "John",
      "billingLastName": "Doe",
      "merchantPaymentMethodRefId": null,
      "billingAddress": {
        "addressId": 1,
        "addressLine1": "1 Default Street",
        "addressLine2": null,
        "city": "Los Angeles",
        "state": "CA",
        "postalCode": "90210",
        "phoneNumber": null,
        "email": null,
        "country": "US"
      },
      "paymentMethodAchDetails": null,
      "paymentMethodCreditCardDetails": null
    },
    "invoiceStatus": "PartialRefund",
    "subtotal": 10.99,
    "tax": 0.1,
    "total": 11.09,
    "billingDate": "30.06.2026",
    "merchantLegalName": "John Doe",
    "merchantCustomerRefId": "80a0b225-b38e-4971-b475-f36b8fef0457",
    "customerFirstName": "John",
    "customerLastName": "Doe",
    "subscriptionId": null,
    "installmentId": null,
    "eligibilityFailReason": null,
    "merchantSubscriptionRefId": null,
    "networkTransactionId": null,
    "currency": null,
    "invoiceLineItems": null,
    "invoiceAttempts": null,
    "voidAttempts": null
  },
  "refunds": [
    {
      "invoiceAttemptId": 1,
      "amount": -3.99,
      "invoiceAttemptStatus": "Success",
      "invoiceAttemptDate": "2026-07-01T11:31:34.8866527Z",
      "paymentProcessor": "BridgePay",
      "processorTransactionId": null,
      "responseCode": null,
      "responseMessage": null,
      "processorRawResponse": null,
      "paymentMethod": {
        "paymentMethodId": 0,
        "billingAddressId": 0,
        "billingAddress": null,
        "billingFirstName": null,
        "billingLastName": null,
        "merchantPaymentMethodRefId": null,
        "paymentMethodAchDetails": null,
        "paymentMethodCreditCardDetails": null
      },
      "descriptor": {
        "subMerchantId": null,
        "subMerchantName": null,
        "subMerchantPhone": null,
        "countryCode": null,
        "city": null
      },
      "eligibilityCheckOrderCode": null,
      "processorMerchantId": null,
      "processingMethod": "None",
      "revolv3ResponseCode": null,
      "revolv3ResponseMessage": null,
      "authCode": null,
      "processorResponseDateTime": "2026-07-01T11:31:34.8866527Z"
    }
  ],
  "refundedSubtotal": 5.99,
  "refundedTax": 0.05,
  "refundedTotal": 6.04,
  "rawResponse": null,
  "message": null,
  "responseCode": null,
  "responseMessage": null,
  "revolv3ResponseCode": null,
  "revolv3ResponseMessage": null
}

Authorizations

x-revolv3-token
string
header
required

Path Parameters

invoiceId
integer<int64>
required
Required range: 1 <= x <= 1000000000

Body

amount
number<double> | null
Required range: 0.01 <= x <= 10000000
includeRawProcessorResponse
boolean | null
reportGroup
string

Report Groups could be used to separate your transactions into different categories, so you can view the financial reports by your specific report group names (Worldpay only).

Response

OK

invoice
object
refunds
object[] | null
refundedSubtotal
number<double>
refundedTax
number<double>
refundedTotal
number<double>
rawResponse
string | null
message
string | null
responseCode
string | null
responseMessage
string | null
revolv3ResponseCode
string | null
revolv3ResponseMessage
string | null