abacatepay.payout.withdraw-available ​
Check available balance, create payout, await settlement.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Dag |
| Library | App-abacatepay |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
cloud_connection_uuid | uuid | Yes | — | — |
workflow_run_id | string | No | — | — |
amount | integer | Yes | — | — |
description | string | No | — | — |
metadata | json | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
cloud_connection_uuid | uuid | Yes | — | — |
workflow_run_id | string | No | — | — |
balance_available | integer | Yes | — | — |
payout_ref | string | Yes | — | — |
status | string | Yes | — | — |
receipt_url | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | integer | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
provider_request_ref | string | No | — | — |
retryable | boolean | No | — | — |
get_store | json | No | — | — |
create_payout | json | No | — | — |
await_settlement | json | No | — | — |
amount | integer | Yes | — | — |
description | string | No | — | — |
metadata | json | No | — | — |
DAG Layers ​
| # | Layer | Steps | Compensation |
|---|---|---|---|
| 1 | guard | abacatepay.store.get | — |
| 2 | withdraw | abacatepay.payout.create | — |
| 3 | await | abacatepay.payout.await-settlement | — |
Execution Flow ​
Sub-workflows ​
| Sub-workflow | Step name |
|---|---|
abacatepay.store.get | get_store |
abacatepay.payout.create | create_payout |
abacatepay.payout.await-settlement | await_settlement |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "abacatepay.payout.withdraw-available",
"initial_data": {
"organization_uuid": "value",
"cloud_connection_uuid": "value",
"amount": 123
}
}