Skip to main content
PUT
Record a Payment observation

Authorizations

Authorization
string
header
required

Environment-specific Integration key. Never paste a live key into documentation tooling.

Path Parameters

clientCode
string
required

Granted Local Authority Client code

Pattern: ^[A-Z][A-Z0-9]{1,31}$
Example:

"SDCC"

clientReferenceId
string
required

Stable partner Matter key; must not contain personal data 1-128 characters; . and .. alone are refused.

Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._-]{1,128}$
Example:

"SDCC-2026-00482"

externalPaymentId
string
required

Stable Payment observation key; must not contain personal data 1-128 characters; . and .. alone are refused.

Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._-]{1,128}$
Example:

"payobs_01JEXAMPLE"

Body

application/json
type
enum<string>
required
Available options:
payment,
refund
amount
string
required
Maximum string length: 15
Pattern: ^(0\.(0[1-9]|[1-9][0-9])|[1-9][0-9]*\.[0-9]{2})$
Example:

"200.00"

currency
string
required
Pattern: ^[A-Z]{3}$
effectiveOn
string<date>
required

Real calendar date, 2000-01-01 or later and at most 31 days after today (UTC); evidence only.

channel
enum<string>
required
Available options:
direct_to_creditor,
bank_transfer,
card,
cash,
other
resultingOutstandingAmount
string
required
Maximum string length: 15
Pattern: ^(0|[1-9][0-9]*)\.[0-9]{2}$
Example:

"1250.00"

reference
string
Maximum string length: 2000

Response

Current immutable Payment observation

Payment/refund include channel; reversal includes reversesExternalPaymentId and omits channel.

clientCode
string
required
Pattern: ^[A-Z][A-Z0-9]{1,31}$
Example:

"SDCC"

clientReferenceId
string
required

1-128 characters; . and .. alone are refused.

Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._-]{1,128}$
Example:

"SDCC-2026-00482"

externalPaymentId
string
required

1-128 characters; . and .. alone are refused.

Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._-]{1,128}$
Example:

"payobs_01JEXAMPLE"

matterId
string
required
type
enum<string>
required
Available options:
payment,
refund,
reversal
amount
string
required
Maximum string length: 15
Pattern: ^(0\.(0[1-9]|[1-9][0-9])|[1-9][0-9]*\.[0-9]{2})$
Example:

"200.00"

currency
string
required
Pattern: ^[A-Z]{3}$
effectiveOn
string<date>
required
resultingOutstandingAmount
string
required
Maximum string length: 15
Pattern: ^(0|[1-9][0-9]*)\.[0-9]{2}$
Example:

"1250.00"

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
channel
enum<string>
required if type = payment or refund
Available options:
direct_to_creditor,
bank_transfer,
card,
cash,
other
reference
string
Maximum string length: 2000
reversesExternalPaymentId
string
required if type = reversal

1-128 characters; . and .. alone are refused.

Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._-]{1,128}$
Example:

"payobs_01JEXAMPLE"