Get a Payment observation

curl --request GET \
  --url https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/payment-observations/{externalPaymentId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/payment-observations/{externalPaymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/payment-observations/{externalPaymentId}"

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

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

print(response.text)

{
  "clientCode": "SDCC",
  "clientReferenceId": "SDCC-2026-00482",
  "externalPaymentId": "payobs_01JEXAMPLE",
  "matterId": "<string>",
  "type": "payment",
  "amount": "200.00",
  "currency": "<string>",
  "effectiveOn": "2023-12-25",
  "resultingOutstandingAmount": "1250.00",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "channel": "direct_to_creditor",
  "reference": "<string>",
  "reversesExternalPaymentId": "payobs_01JEXAMPLE"
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

GET

clients

{clientCode}

matters

by-client-reference

{clientReferenceId}

payment-observations

{externalPaymentId}

Get a Payment observation

curl --request GET \
  --url https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/payment-observations/{externalPaymentId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/payment-observations/{externalPaymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/payment-observations/{externalPaymentId}"

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

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

print(response.text)

{
  "clientCode": "SDCC",
  "clientReferenceId": "SDCC-2026-00482",
  "externalPaymentId": "payobs_01JEXAMPLE",
  "matterId": "<string>",
  "type": "payment",
  "amount": "200.00",
  "currency": "<string>",
  "effectiveOn": "2023-12-25",
  "resultingOutstandingAmount": "1250.00",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "channel": "direct_to_creditor",
  "reference": "<string>",
  "reversesExternalPaymentId": "payobs_01JEXAMPLE"
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

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"

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"

Get started

Guides

API reference

Get a Payment observation

Authorizations

Path Parameters

Response