Skip to content
FRAGMENT
API Reference
Experimental

Payment Flows

Create
experimental.payment_flows.create(PaymentFlowCreateParams**kwargs) -> PaymentFlowCreateResponse
POST/payment-flows
Retrieve
experimental.payment_flows.retrieve(strpayment_flow_ref) -> PaymentFlowRetrieveResponse
GET/payment-flows/{payment_flow_ref}
Search
experimental.payment_flows.search(PaymentFlowSearchParams**kwargs) -> PaymentFlowSearchResponse
POST/payment-flows/search
ModelsExpand Collapse
class PaymentFlow: …

Payment flow object.

id: str

FRAGMENT generated unique ID.

created: str

Timestamp when the payment flow was created.

external_id: str

User-provided unique external ID.

invoice: Invoice

Invoice being settled.

id: str

Invoice identifier.

external_id: Optional[str]

Invoice external ID.

modified: str

Timestamp when the payment flow was last modified.

payment_plan: PaymentPlan

Payment plan for UI rendering.

batches: List[PaymentPlanBatch]

Payment batches.

batch_id: str

Batch identifier.

depends_on: List[str]

Batches this one depends on.

label: str

Human-readable batch label.

payments: List[PaymentPlanBatchPayment]

Payments in this batch.

amount: str

Amount in smallest currency unit.

currency: str

Currency code.

direction: str

Direction of the payment.

payment_id: str

FRAGMENT generated unique ID.

status: str

Status of the payment.

user: PaymentPlanBatchPaymentUser

User associated with the payment.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

status: str

Batch status.

generated_at: str

When the plan was generated.

invoice_id: str

Invoice identifier.

version: float

Plan version.

status: str

Status of the payment flow.

type: str

Type of payment flow.