abacatepay.checkout.list ​
List hosted checkouts for the store.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-abacatepay |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Authenticated organization UUID |
cloud_connection_uuid | uuid | Yes | — | Organization-scoped AbacatePay connection UUID |
workflow_run_id | string | No | — | Engine-stamped parent DAG run id |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Authenticated organization UUID |
cloud_connection_uuid | uuid | Yes | — | Organization-scoped AbacatePay connection UUID |
workflow_run_id | string | No | — | Engine-stamped parent DAG run id |
checkouts | list | Yes | — | Checkout list. Each item must include 'checkout_ref' and 'id' for GIDR pickers (LIST_ITEM_KEYS). |
checkout_count | integer | Yes | — | Number of checkouts returned |
read_at | string | Yes | — | ISO-8601 read timestamp |
failure_reason | string | No | — | Safe terminal failure reason |
failure_type | string | No | — | Stable failure classification |
failed_action | string | No | — | Action that failed |
failed_step | json | No | — | Failed DAG step envelope |
failed_layer | integer | No | — | One-based failed DAG layer |
failed_at_state | string | No | — | State where failure occurred |
error | string | No | — | Safe unexpected error |
error_type | string | No | — | Unexpected exception class |
failed_at | string | No | — | ISO-8601 failure timestamp |
provider_request_ref | string | No | — | Safe provider request reference |
retryable | boolean | No | — | Whether the failure is retryable |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "abacatepay.checkout.list",
"initial_data": {
"organization_uuid": "value",
"cloud_connection_uuid": "value"
}
}