Skip to content

Acknowledge caregiver payout receipt

POST
/caregiver-payout-receipt-states/acknowledgements
curl --request POST \
--url https://example.com/caregiver-payout-receipt-states/acknowledgements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "reservationBookingId": "example", "contractAssignmentKey": "example", "caregiverPayoutInstructionId": "example", "caregiverRole": "primary", "handoffOrder": 1, "caregiverId": "example", "occurredAt": "2026-04-15T12:00:00Z", "idempotencyKey": "example", "expectedRevision": 1, "reason": "example" }'
Media typeapplication/json
CaregiverPayoutReceiptStateCommandRequest
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
occurredAt
required
string format: date-time
idempotencyKey
required
string
>= 1 characters
expectedRevision
required
integer
reason
required
string
>= 1 characters
key
additional properties

Caregiver payout receipt state advanced

Media typeapplication/json
CaregiverPayoutReceiptStateResponse
object
reservationBookingId
required
string
>= 1 characters
contractAssignmentKey
required
string
>= 1 characters
caregiverPayoutInstructionId
required
string
>= 1 characters
receiptState
required
string
Allowed values: pending acknowledged exception_reported repaired
revision
required
integer
status
required
string
>= 1 characters
reason
required
string | null
>= 1 characters
actorProfileId
required
string | null
>= 1 characters
occurredAt
required
string | null format: date-time
key
additional properties

Supabase bearer token is required

Actor cannot acknowledge caregiver payout receipt

Caregiver payout receipt-state revision or idempotency conflict

Caregiver payout receipt-state command runtime is unavailable