Skip to content
Proud to collaborate with Microsoft for Startups

abacatepay.payout.get ​

Get a payout by provider id.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-abacatepay
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Authenticated organization UUID
cloud_connection_uuiduuidYes—Organization-scoped AbacatePay connection UUID
workflow_run_idstringNo—Engine-stamped parent DAG run id
payout_refstringYes—Provider payout id

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Authenticated organization UUID
cloud_connection_uuiduuidYes—Organization-scoped AbacatePay connection UUID
workflow_run_idstringNo—Engine-stamped parent DAG run id
payout_refstringYes—Provider payout id
statusstringYes—Payout status
receipt_urlstringNo—Receipt URL when COMPLETE
payoutjsonYes—Normalized payout payload
read_atstringYes—ISO-8601 read timestamp
failure_reasonstringNo—Safe terminal failure reason
failure_typestringNo—Stable failure classification
failed_actionstringNo—Action that failed
failed_stepjsonNo—Failed DAG step envelope
failed_layerintegerNo—One-based failed DAG layer
failed_at_statestringNo—State where failure occurred
errorstringNo—Safe unexpected error
error_typestringNo—Unexpected exception class
failed_atstringNo—ISO-8601 failure timestamp
provider_request_refstringNo—Safe provider request reference
retryablebooleanNo—Whether the failure is retryable

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "abacatepay.payout.get",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value",
    "payout_ref": "value"
  }
}