Record an immutable CreditNote
curl --request PUT \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "credit_note",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"externalReceivableId": "REC_EXAMPLE",
"sourceRevision": 2,
"effectiveAt": "2026-10-14T12:00:00Z",
"reason": "billing_correction",
"sourceReference": "CREDIT_SOURCE"
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'credit_note',
amount: {amount: '10.00', currency: 'EUR'},
externalReceivableId: 'REC_EXAMPLE',
sourceRevision: 2,
effectiveAt: '2026-10-14T12:00:00Z',
reason: 'billing_correction',
sourceReference: 'CREDIT_SOURCE'
})
};
fetch('https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId}"
payload = {
"type": "credit_note",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"externalReceivableId": "REC_EXAMPLE",
"sourceRevision": 2,
"effectiveAt": "2026-10-14T12:00:00Z",
"reason": "billing_correction",
"sourceReference": "CREDIT_SOURCE"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId}"
payload := strings.NewReader("{\n \"type\": \"credit_note\",\n \"amount\": {\n \"amount\": \"10.00\",\n \"currency\": \"EUR\"\n },\n \"externalReceivableId\": \"REC_EXAMPLE\",\n \"sourceRevision\": 2,\n \"effectiveAt\": \"2026-10-14T12:00:00Z\",\n \"reason\": \"billing_correction\",\n \"sourceReference\": \"CREDIT_SOURCE\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"credit_note\",\n \"amount\": {\n \"amount\": \"10.00\",\n \"currency\": \"EUR\"\n },\n \"externalReceivableId\": \"REC_EXAMPLE\",\n \"sourceRevision\": 2,\n \"effectiveAt\": \"2026-10-14T12:00:00Z\",\n \"reason\": \"billing_correction\",\n \"sourceReference\": \"CREDIT_SOURCE\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"type\": \"credit_note\",\n \"amount\": {\n \"amount\": \"10.00\",\n \"currency\": \"EUR\"\n },\n \"externalReceivableId\": \"REC_EXAMPLE\",\n \"sourceRevision\": 2,\n \"effectiveAt\": \"2026-10-14T12:00:00Z\",\n \"reason\": \"billing_correction\",\n \"sourceReference\": \"CREDIT_SOURCE\"\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
{
"type": "credit_note",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"externalReceivableId": "REC_EXAMPLE",
"sourceRevision": 2,
"effectiveAt": "2026-10-14T12:00:00Z",
"reason": "billing_correction",
"sourceReference": "CREDIT_SOURCE",
"externalEventId": "EVENT_EXAMPLE",
"acceptedAt": "2026-10-14T12:00:01Z"
}Financial events
Record an immutable CreditNote
Record a CreditNote issued in the Source, which changes a Receivable’s balance. Requires financial_corrections:write. The type must match the resource family. Credits and write-offs decrease balances; adjustments declare their direction. Exact retries are safe; changed identities and stale source revisions conflict. These operations do not collect money or initiate refunds.
PUT
/
v1
/
clients
/
{clientCode}
/
credit-notes
/
{externalEventId}
Record an immutable CreditNote
curl --request PUT \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "credit_note",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"externalReceivableId": "REC_EXAMPLE",
"sourceRevision": 2,
"effectiveAt": "2026-10-14T12:00:00Z",
"reason": "billing_correction",
"sourceReference": "CREDIT_SOURCE"
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'credit_note',
amount: {amount: '10.00', currency: 'EUR'},
externalReceivableId: 'REC_EXAMPLE',
sourceRevision: 2,
effectiveAt: '2026-10-14T12:00:00Z',
reason: 'billing_correction',
sourceReference: 'CREDIT_SOURCE'
})
};
fetch('https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId}"
payload = {
"type": "credit_note",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"externalReceivableId": "REC_EXAMPLE",
"sourceRevision": 2,
"effectiveAt": "2026-10-14T12:00:00Z",
"reason": "billing_correction",
"sourceReference": "CREDIT_SOURCE"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId}"
payload := strings.NewReader("{\n \"type\": \"credit_note\",\n \"amount\": {\n \"amount\": \"10.00\",\n \"currency\": \"EUR\"\n },\n \"externalReceivableId\": \"REC_EXAMPLE\",\n \"sourceRevision\": 2,\n \"effectiveAt\": \"2026-10-14T12:00:00Z\",\n \"reason\": \"billing_correction\",\n \"sourceReference\": \"CREDIT_SOURCE\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"credit_note\",\n \"amount\": {\n \"amount\": \"10.00\",\n \"currency\": \"EUR\"\n },\n \"externalReceivableId\": \"REC_EXAMPLE\",\n \"sourceRevision\": 2,\n \"effectiveAt\": \"2026-10-14T12:00:00Z\",\n \"reason\": \"billing_correction\",\n \"sourceReference\": \"CREDIT_SOURCE\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/credit-notes/{externalEventId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"type\": \"credit_note\",\n \"amount\": {\n \"amount\": \"10.00\",\n \"currency\": \"EUR\"\n },\n \"externalReceivableId\": \"REC_EXAMPLE\",\n \"sourceRevision\": 2,\n \"effectiveAt\": \"2026-10-14T12:00:00Z\",\n \"reason\": \"billing_correction\",\n \"sourceReference\": \"CREDIT_SOURCE\"\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
{
"type": "credit_note",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"externalReceivableId": "REC_EXAMPLE",
"sourceRevision": 2,
"effectiveAt": "2026-10-14T12:00:00Z",
"reason": "billing_correction",
"sourceReference": "CREDIT_SOURCE",
"externalEventId": "EVENT_EXAMPLE",
"acceptedAt": "2026-10-14T12:00:01Z"
}Authorizations
Integration-owned environment-specific API key. Never paste a production key into documentation tools.
Path Parameters
Pattern:
^[A-Za-z0-9_-]{1,128}$Pattern:
^[A-Za-z0-9_-]{1,128}$Body
application/json
One uncompressed resource representation, limited to 256 KiB.
Show child attributes
Show child attributes
Pattern:
^[A-Za-z0-9_-]{1,128}$Required range:
x <= 9007199254740991Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Available options:
billing_correction, contractual_credit Required string length:
1 - 200Allowed value:
"credit_note"Response
Identical safe retry.
Show child attributes
Show child attributes
Pattern:
^[A-Za-z0-9_-]{1,128}$Required range:
x <= 9007199254740991Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Available options:
billing_correction, contractual_credit Required string length:
1 - 200Allowed value:
"credit_note"Pattern:
^[A-Za-z0-9_-]{1,128}$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$