Void Invoice Refund

Void a previously-issued refund (credit note). Reverses the credit note in the tax provider and excludes it from revenue. Accessible to the owning merchant or platform operators.

POST /v2/invoices/{id}/refunds/{refundId}/void

Void Invoice Refund

cURL

curl --request POST \
  --url https://api.paygentic.io/v2/invoices/{id}/refunds/{refundId}/void \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://api.paygentic.io/v2/invoices/{id}/refunds/{refundId}/void"

payload = { "reason": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.paygentic.io/v2/invoices/{id}/refunds/{refundId}/void', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paygentic.io/v2/invoices/{id}/refunds/{refundId}/void",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paygentic.io/v2/invoices/{id}/refunds/{refundId}/void"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.paygentic.io/v2/invoices/{id}/refunds/{refundId}/void")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v2/invoices/{id}/refunds/{refundId}/void")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "object": "invoice_refund",
  "id": "<string>",
  "invoiceId": "<string>",
  "merchantId": "<string>",
  "amount": "<string>",
  "taxAmount": "<string>",
  "total": "<string>",
  "currency": "<string>",
  "externalCreditNoteId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "permalink": "<string>",
  "pdfUrl": "<string>",
  "reason": "<string>",
  "voidedAt": "2023-11-07T05:31:56Z"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

Authorizations

Authorization · string · header · required

API key authentication

Path Parameters

id · string · required

The invoice ID

refundId · string · required

The refund (credit note) ID

Body

application/json

reason · string

Optional reason for voiding the refund (recorded on the credit note)

Response

200

application/json

Refund voided

object · enum<string> · required

The object type

Available options: invoice_refund

id · string · required

The credit note ID (crn_*)

invoiceId · string · required

The invoice this refund credits

merchantId · string · required

The merchant that owns the invoice

amount · string · required

Refunded subtotal (pre-tax) in decimal dollars

taxAmount · string · required

Reversed tax in decimal dollars

total · string · required

Total refunded (amount + taxAmount) in decimal dollars

currency · string · required

ISO 4217 currency code

status · enum<string> · required

Credit note status

Available options: ISSUED, VOIDED

externalCreditNoteId · string · required

Credit note id in the tax provider

createdAt · string<date-time> · required

When the refund was issued

permalink · string | null

Public URL to view the credit note document

pdfUrl · string | null

Direct PDF download link

reason · string | null

Optional refund reason

voidedAt · string<date-time> | null

When the refund was voided, if applicable