PApayabli
caseManagement

Get case

Returns a case by its UUID, including its current state, parameters, state history, verification metadata, and attachments.

Available to both Platform and Enterprise Partners.

get/v2/cases/{uuid}

Request

  • Base URL
    https://api-sandbox.payabli.com/api
  • URL
    https://api-sandbox.payabli.com/api/v2/cases/{uuid}
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required

The case's UUID.

Response

The case

uuidstring uuid required

The case's unique identifier.

state'Submitted' | 'Verifying' | 'PendingReview' | 'Assigned' | 'PendingResponse' | 'Escalated' | 'Approved' | 'AutoApproved' | 'PendingCompletion' | 'Completed' | 'Denied' | 'Error' required

The state of a case in the bank-account-change lifecycle. Completed and Denied are terminal.

caseType'BankAccountChange' required

Bank account changes are currently the only supported case type.

orgIdinteger required

The organization that owns the case.

paypointIdinteger required

The paypoint the case applies to.

scheduleForstring date-time nullable required

When the change is scheduled to run. Null when not scheduled.

createdAtstring date-time required

When the case was created.

updatedAtstring date-time required

When the case was last updated.

createdByinteger required

The numeric id of the user who created the case. 0 when created by a server-side integration.

assigneeIdinteger nullable required

The numeric id of the assigned reviewer. Null when unassigned.

lastReviewedByIdinteger nullable required

The numeric id of the last reviewer. Null when not yet reviewed.

roomIdinteger nullable required

The id of the message room for the case. Null until provisioned.

Changes

No recorded changes to this operation across all 9 revisions of this API.