Record an immutable Adjustment
curl --request PUT \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/adjustments/{externalEventId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "adjustment",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"externalReceivableId": "REC_EXAMPLE",
"sourceRevision": 2,
"effectiveAt": "2026-10-14T12:00:00Z",
"reason": "billing_correction",
"sourceReference": "CREDIT_SOURCE",
"direction": "decrease"
}
'{
"type": "adjustment",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"externalReceivableId": "REC_EXAMPLE",
"sourceRevision": 2,
"effectiveAt": "2026-10-14T12:00:00Z",
"reason": "billing_correction",
"sourceReference": "CREDIT_SOURCE",
"direction": "decrease",
"externalEventId": "EVENT_EXAMPLE",
"acceptedAt": "2026-10-14T12:00:01Z"
}API Reference
Record an immutable Adjustment
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}
/
adjustments
/
{externalEventId}
Record an immutable Adjustment
curl --request PUT \
--url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/adjustments/{externalEventId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "adjustment",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"externalReceivableId": "REC_EXAMPLE",
"sourceRevision": 2,
"effectiveAt": "2026-10-14T12:00:00Z",
"reason": "billing_correction",
"sourceReference": "CREDIT_SOURCE",
"direction": "decrease"
}
'{
"type": "adjustment",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"externalReceivableId": "REC_EXAMPLE",
"sourceRevision": 2,
"effectiveAt": "2026-10-14T12:00:00Z",
"reason": "billing_correction",
"sourceReference": "CREDIT_SOURCE",
"direction": "decrease",
"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, source_adjustment Required string length:
1 - 200Allowed value:
"adjustment"Available options:
increase, decrease 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, source_adjustment Required string length:
1 - 200Allowed value:
"adjustment"Available options:
increase, decrease 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))$