List Invoice Refunds

List the credit notes (refunds) recorded against an invoice. Accessible to the owning merchant or platform operators.

GET /v2/invoices/{id}/refunds

List Invoice Refunds

cURL

curl --request GET \
  --url https://api.paygentic.io/v2/invoices/{id}/refunds \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paygentic.io/v2/invoices/{id}/refunds', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.paygentic.io/v2/invoices/{id}/refunds")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "object": "list",
  "data": [
    {
      "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"
}

Authorizations

Authorization · string · header · required

API key authentication

Path Parameters

id · string · required

The invoice ID

Response

200

application/json

List of refunds

object · enum<string> · required

The object type

Available options: list

data · object[] · required

The refunds for this invoice

Show child attributes