Record a Payment observation

curl --request PUT \ --url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/payment-observations/{externalPaymentObservationId} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "amount": { "amount": "250.00", "currency": "EUR" }, "effectiveAt": "2026-08-29T11:45:00Z", "externalReceivableId": "REC_123", "method": "bank_transfer", "resultingRecoverableAmount": { "amount": "1000.00", "currency": "EUR" }, "sourceReference": "payment-ref-example", "type": "payment" } '

{ "amount": { "amount": "250.00", "currency": "EUR" }, "effectiveAt": "2026-08-29T11:45:00Z", "externalReceivableId": "REC_123", "method": "bank_transfer", "resultingRecoverableAmount": { "amount": "1000.00", "currency": "EUR" }, "sourceReference": "payment-ref-example", "type": "payment", "acceptedAt": "2026-08-29T12:00:00Z", "externalPaymentObservationId": "PAY_123" }

Authorizations

Authorization

string

header

required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Path Parameters

clientCode

string

required

Stable non-sensitive Client code authorized by the Integration grant.

Pattern: ^[A-Za-z0-9_-]{1,128}$

externalPaymentObservationId

string

required

Opaque immutable Payment-observation identifier supplied by the Integration.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Body

application/json

Maximum uncompressed request body size: 256 KiB.

Option 1
Option 2
Option 3

Payment decreases and refund or reversal increases the locked Receivable balance; resultingRecoverableAmount must match exactly.

amount

object

required

Show child attributes

effectiveAt

string<date-time>

required

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))$

externalReceivableId

string

required

Pattern: ^[A-Za-z0-9_-]{1,128}$

method

enum<string>

required

Available options:

bank_transfer,

direct_debit,

card,

cash,

cheque,

unknown

resultingRecoverableAmount

object

required

Show child attributes

sourceReference

string

required

Required string length: 1 - 200

type

string

required

Allowed value: "payment"

Response

Identical retry of the accepted observation.

Option 1
Option 2
Option 3

amount

object

required

Show child attributes

effectiveAt

string<date-time>

required

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))$

externalReceivableId

string

required

Pattern: ^[A-Za-z0-9_-]{1,128}$

method

enum<string>

required

Available options:

bank_transfer,

direct_debit,

card,

cash,

cheque,

unknown

resultingRecoverableAmount

object

required

Show child attributes

sourceReference

string

required

Required string length: 1 - 200

type

string

required

Allowed value: "payment"

acceptedAt

string<date-time>

required

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))$

externalPaymentObservationId

string

required

Pattern: ^[A-Za-z0-9_-]{1,128}$

Parties

Payment observations

Receivables

Receivable lifecycle

Record a Payment observation

Authorizations

Path Parameters

Body

Response