Get case

GET

/v2/cases/:uuid

GET

/api/v2/cases/:uuid

$ curl https://api-sandbox.payabli.com/api/v2/cases/9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70

1 {
2   "uuid": "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
3   "state": "PendingCompletion",
4   "caseType": "BankAccountChange",
5   "parameters": {
6     "type": "BankAccountChange",
7     "nickname": "Main Settlement Account",
8     "bankName": "First National Bank",
9     "bankToken": "bnk_2b1c9e40f5a34c9a8f219e7c6b1a2d34",
10     "accountType": "Checking",
11     "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
12     "bankAccountHolderType": "business",
13     "bankAccountFunction": "Deposits",
14     "services": {
15       "moneyIn": [
16         "Ach"
17       ],
18       "moneyOut": [
19         "Ach"
20       ]
21     },
22     "default": true
23   },
24   "orgId": 123,
25   "paypointId": 3040,
26   "scheduleFor": null,
27   "createdAt": "2026-01-15T10:30:00Z",
28   "updatedAt": "2026-01-15T10:30:43Z",
29   "createdBy": 0,
30   "assigneeId": null,
31   "lastReviewedById": null,
32   "stateHistory": [
33     {
34       "uuid": "019f806f-453f-701c-b77d-cb585b743bef",
35       "caseUuid": "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
36       "fromState": "Submitted",
37       "toState": "Verifying",
38       "ipAddress": null,
39       "triggeredBy": null,
40       "reason": "Background verification started",
41       "createdAt": "2026-01-15T10:30:03Z",
42       "triggeredByUser": null
43     },
44     {
45       "uuid": "019f806f-e00e-73d2-b6a4-9dd5b540e11e",
46       "caseUuid": "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
47       "fromState": "Verifying",
48       "toState": "AutoApproved",
49       "ipAddress": null,
50       "triggeredBy": null,
51       "reason": "Polling outcome: approved",
52       "createdAt": "2026-01-15T10:30:43Z",
53       "triggeredByUser": null
54     },
55     {
56       "uuid": "019f806f-e015-730b-be18-ec695f42f133",
57       "caseUuid": "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
58       "fromState": "AutoApproved",
59       "toState": "PendingCompletion",
60       "ipAddress": null,
61       "triggeredBy": null,
62       "reason": "funding hold acquired",
63       "createdAt": "2026-01-15T10:30:43Z",
64       "triggeredByUser": null
65     }
66   ],
67   "attachments": [],
68   "roomId": 96369,
69   "metadata": {
70     "verification": {
71       "verificationResult": {
72         "code": 6,
73         "name": "Pass",
74         "description": "The suggested action is to accept the bank account and/or customer data for this inquiry."
75       },
76       "accountResponseCode": {
77         "code": 12,
78         "name": "_1111",
79         "description": "Account Verified – The account was found to be an open and valid checking account."
80       },
81       "customerResponseCode": null
82     },
83     "reviewDecision": null
84   },
85   "org": {
86     "id": 123,
87     "name": "Example Partner Org"
88   },
89   "paypoint": {
90     "id": 3040,
91     "name": "Gruzya Adventure Outfitters"
92   },
93   "createdByUser": null,
94   "assignee": null,
95   "lastReviewedBy": null
96 }

Returns a case by its UUID, including its current state, parameters, state history, verification metadata, and attachments. Available to both Platform and Enterprise Partners.

Path parameters

uuidstringRequiredformat: "uuid"

The case's UUID.

Response

The case

uuidstringformat: "uuid"

The case's unique identifier.

stateenum

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

caseTypeenum

Bank account changes are currently the only supported case type.

parametersobject

The bank-account-change details stored on a case. The raw account and routing numbers are write-only and never appear here — only a vault token (bankToken) and non-sensitive details.

orgIdlong

The organization that owns the case.

paypointIdlong

The paypoint the case applies to.

scheduleFordatetime or null

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

createdAtdatetime

When the case was created.

updatedAtdatetime

When the case was last updated.

createdBylong

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

assigneeIdlong or null

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

lastReviewedByIdlong or null

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

stateHistorylist of objects

The ordered history of state transitions.

attachmentslist of objects

Files attached to the case.

roomIdlong or null

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

metadataobject or null

Case metadata, including the verification outcome. Null until verification completes.

orgobject or null

The resolved organization. Null when not enriched.

paypointobject or null

The resolved paypoint. Null when not enriched.

createdByUserobject or null

The resolved creator. Null when created by a server-side integration or not enriched.

assigneeobject or null

The resolved assigned reviewer. Null when unassigned.

lastReviewedByobject or null

The resolved last reviewer. Null when not yet reviewed.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error