abacatepay.checkout.create

Create a hosted checkout and return the payment URL.

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
items	list	Yes	—	Checkout items [{id, quantity}] using provider product ids
methods	list	No	—	Payment methods: PIX, CARD, BOLETO
customer_ref	string	No	—	Provider customer id (customerId)
return_url	string	No	—	Back URL on hosted checkout
completion_url	string	No	—	Success redirect URL
coupons	list	No	—	Coupon codes allowed on this checkout
external_id	string	No	—	Caller reference id
upsell_product_ref	string	No	—	One-time upsell product id
due_date	string	No	—	BOLETO due date YYYY-MM-DD
metadata	json	No	—	Caller metadata bag

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
checkout_ref	string	Yes	—	Provider checkout/billing id
checkout_url	string	Yes	—	Hosted payment URL
amount	integer	Yes	—	Total amount in centavos
status	string	Yes	—	Checkout status
external_id	string	No	—	Caller reference id
checkout	json	Yes	—	Normalized checkout payload
created_at	string	Yes	—	ISO-8601 create 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
items	list	Yes	—	Checkout items [{id, quantity}] using provider product ids
methods	list	No	—	Payment methods: PIX, CARD, BOLETO
customer_ref	string	No	—	Provider customer id (customerId)
return_url	string	No	—	Back URL on hosted checkout
completion_url	string	No	—	Success redirect URL
coupons	list	No	—	Coupon codes allowed on this checkout
upsell_product_ref	string	No	—	One-time upsell product id
due_date	string	No	—	BOLETO due date YYYY-MM-DD
metadata	json	No	—	Caller metadata bag

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

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

{
  "workflow_type": "abacatepay.checkout.create",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value",
    "items": "value"
  }
}