Skip to content

Record caregiver payout destination change audit

POST
/caregiver-payout-destination-change-audits
curl --request POST \
--url https://example.com/caregiver-payout-destination-change-audits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "reservationBookingId": "example", "contractAssignmentKey": "example", "caregiverPayoutInstructionId": "example", "caregiverRole": "primary", "handoffOrder": 1, "caregiverId": "example", "previousDestination": { "accountHolderName": "example", "accountNumber": "example", "taxEvidenceReferenceId": "example", "bankName": "example" }, "adjustedDestination": { "accountHolderName": "example", "accountNumber": "example", "taxEvidenceReferenceId": "example", "bankName": "example" }, "occurredAt": "2026-04-15T12:00:00Z", "idempotencyKey": "example", "expectedRevision": 1, "reason": "example" }'
Media typeapplication/json
CaregiverPayoutDestinationChangeAuditRequest
object
reservationBookingId
required
string
>= 1 characters
contractAssignmentKey
required
string
>= 1 characters
caregiverPayoutInstructionId
required
string
>= 1 characters
caregiverRole
required
string
Allowed values: primary assistant
handoffOrder
required
integer
caregiverId
string | null
>= 1 characters
previousDestination
required
object
accountHolderName
required
string
>= 1 characters
accountNumber
required
string
>= 1 characters
taxEvidenceReferenceId
required
string
>= 1 characters
bankName
string | null
>= 1 characters
key
additional properties
adjustedDestination
required
object
accountHolderName
required
string
>= 1 characters
accountNumber
required
string
>= 1 characters
taxEvidenceReferenceId
required
string
>= 1 characters
bankName
string | null
>= 1 characters
key
additional properties
occurredAt
required
string format: date-time
idempotencyKey
required
string
>= 1 characters
expectedRevision
required
integer
reason
required
string
>= 1 characters
key
additional properties

Caregiver payout destination change audit recorded

Media typeapplication/json
CaregiverPayoutDestinationChangeAuditResponse
object
reservationBookingId
required
string
>= 1 characters
contractAssignmentKey
required
string
>= 1 characters
caregiverPayoutInstructionId
required
string
>= 1 characters
changedFields
required
Array<string>
>= 1 items unique items
Allowed values: account_holder_name account_number tax_evidence_reference_id bank_name
committedRevision
required
integer
>= 1
status
required
string
>= 1 characters
key
additional properties

Supabase bearer token is required

Actor cannot record caregiver payout destination change

Caregiver payout destination change revision or idempotency conflict

Caregiver payout destination change runtime is unavailable