Skip to content
FRAGMENT
API Reference

Experimental

ExperimentalPayment Flows

Payment flow operations

Create
client.experimental.paymentFlows.create(PaymentFlowCreateParams { external_id, invoice, type } body, RequestOptionsoptions?): PaymentFlowCreateResponse { data }
POST/payment-flows
Retrieve
client.experimental.paymentFlows.retrieve(stringpaymentFlowRef, RequestOptionsoptions?): PaymentFlowRetrieveResponse { data }
GET/payment-flows/{payment_flow_ref}
Search
client.experimental.paymentFlows.search(PaymentFlowSearchParams { invoice_id, page_info } body?, RequestOptionsoptions?): PaymentFlowSearchResponse { data }
POST/payment-flows/search
ModelsExpand Collapse
PaymentFlow { id, created, external_id, 5 more }

Payment flow object.

id: string

FRAGMENT generated unique ID.

created: string

Timestamp when the payment flow was created.

external_id: string

User-provided unique external ID.

invoice: Invoice { id, external_id }

Invoice being settled.

id: string

Invoice identifier.

external_id?: string

Invoice external ID.

modified: string

Timestamp when the payment flow was last modified.

payment_plan: PaymentPlan { batches, generated_at, invoice_id, version }

Payment plan for UI rendering.

batches: Array<Batch>

Payment batches.

batch_id: string

Batch identifier.

depends_on: Array<string>

Batches this one depends on.

label: string

Human-readable batch label.

payments: Array<Payment>

Payments in this batch.

amount: string

Amount in smallest currency unit.

currency: string

Currency code.

direction: string

Direction of the payment.

payment_id: string

FRAGMENT generated unique ID.

status: string

Status of the payment.

user: User { id, external_id }

User associated with the payment.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

status: string

Batch status.

generated_at: string

When the plan was generated.

invoice_id: string

Invoice identifier.

version: number

Plan version.

status: string

Status of the payment flow.

type: string

Type of payment flow.

PaymentFlowCreateResponse { data }
data: PaymentFlow { id, created, external_id, 5 more }

Payment flow object.

id: string

FRAGMENT generated unique ID.

created: string

Timestamp when the payment flow was created.

external_id: string

User-provided unique external ID.

invoice: Invoice { id, external_id }

Invoice being settled.

id: string

Invoice identifier.

external_id?: string

Invoice external ID.

modified: string

Timestamp when the payment flow was last modified.

payment_plan: PaymentPlan { batches, generated_at, invoice_id, version }

Payment plan for UI rendering.

batches: Array<Batch>

Payment batches.

batch_id: string

Batch identifier.

depends_on: Array<string>

Batches this one depends on.

label: string

Human-readable batch label.

payments: Array<Payment>

Payments in this batch.

amount: string

Amount in smallest currency unit.

currency: string

Currency code.

direction: string

Direction of the payment.

payment_id: string

FRAGMENT generated unique ID.

status: string

Status of the payment.

user: User { id, external_id }

User associated with the payment.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

status: string

Batch status.

generated_at: string

When the plan was generated.

invoice_id: string

Invoice identifier.

version: number

Plan version.

status: string

Status of the payment flow.

type: string

Type of payment flow.

PaymentFlowRetrieveResponse { data }
data: PaymentFlow { id, created, external_id, 5 more }

Payment flow object.

id: string

FRAGMENT generated unique ID.

created: string

Timestamp when the payment flow was created.

external_id: string

User-provided unique external ID.

invoice: Invoice { id, external_id }

Invoice being settled.

id: string

Invoice identifier.

external_id?: string

Invoice external ID.

modified: string

Timestamp when the payment flow was last modified.

payment_plan: PaymentPlan { batches, generated_at, invoice_id, version }

Payment plan for UI rendering.

batches: Array<Batch>

Payment batches.

batch_id: string

Batch identifier.

depends_on: Array<string>

Batches this one depends on.

label: string

Human-readable batch label.

payments: Array<Payment>

Payments in this batch.

amount: string

Amount in smallest currency unit.

currency: string

Currency code.

direction: string

Direction of the payment.

payment_id: string

FRAGMENT generated unique ID.

status: string

Status of the payment.

user: User { id, external_id }

User associated with the payment.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

status: string

Batch status.

generated_at: string

When the plan was generated.

invoice_id: string

Invoice identifier.

version: number

Plan version.

status: string

Status of the payment flow.

type: string

Type of payment flow.

PaymentFlowSearchResponse { data }

List of payment flows.

data: Array<PaymentFlow { id, created, external_id, 5 more } >
id: string

FRAGMENT generated unique ID.

created: string

Timestamp when the payment flow was created.

external_id: string

User-provided unique external ID.

invoice: Invoice { id, external_id }

Invoice being settled.

id: string

Invoice identifier.

external_id?: string

Invoice external ID.

modified: string

Timestamp when the payment flow was last modified.

payment_plan: PaymentPlan { batches, generated_at, invoice_id, version }

Payment plan for UI rendering.

batches: Array<Batch>

Payment batches.

batch_id: string

Batch identifier.

depends_on: Array<string>

Batches this one depends on.

label: string

Human-readable batch label.

payments: Array<Payment>

Payments in this batch.

amount: string

Amount in smallest currency unit.

currency: string

Currency code.

direction: string

Direction of the payment.

payment_id: string

FRAGMENT generated unique ID.

status: string

Status of the payment.

user: User { id, external_id }

User associated with the payment.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

status: string

Batch status.

generated_at: string

When the plan was generated.

invoice_id: string

Invoice identifier.

version: number

Plan version.

status: string

Status of the payment flow.

type: string

Type of payment flow.

ExperimentalPayments

Payment operations

Retrieve
client.experimental.payments.retrieve(stringpaymentRef, RequestOptionsoptions?): PaymentRetrieveResponse { data }
GET/payments/{payment_ref}
Search
client.experimental.payments.search(PaymentSearchParams { page_info, payment_flow_id } body?, RequestOptionsoptions?): PaymentSearchResponse { data }
POST/payments/search
ModelsExpand Collapse
Payment { id, amount, created, 8 more }

Payment object.

id: string

FRAGMENT generated unique ID.

amount: string

Amount in smallest currency unit.

created: string

Timestamp when the payment was created.

currency: string

Currency code.

direction: string

Direction of the payment.

modified: string

Timestamp when the payment was last modified.

payment_account_id: string

Payment account ID.

payment_flow_id: string

Payment flow ID.

status: string

Status of the payment.

transaction_ids: Array<string>

Associated transaction IDs.

external_id?: string

User-provided unique ID when the payment was created with one.

PaymentRetrieveResponse { data }
data: Payment { id, amount, created, 8 more }

Payment object.

id: string

FRAGMENT generated unique ID.

amount: string

Amount in smallest currency unit.

created: string

Timestamp when the payment was created.

currency: string

Currency code.

direction: string

Direction of the payment.

modified: string

Timestamp when the payment was last modified.

payment_account_id: string

Payment account ID.

payment_flow_id: string

Payment flow ID.

status: string

Status of the payment.

transaction_ids: Array<string>

Associated transaction IDs.

external_id?: string

User-provided unique ID when the payment was created with one.

PaymentSearchResponse { data }

List of payments.

data: Array<Payment { id, amount, created, 8 more } >
id: string

FRAGMENT generated unique ID.

amount: string

Amount in smallest currency unit.

created: string

Timestamp when the payment was created.

currency: string

Currency code.

direction: string

Direction of the payment.

modified: string

Timestamp when the payment was last modified.

payment_account_id: string

Payment account ID.

payment_flow_id: string

Payment flow ID.

status: string

Status of the payment.

transaction_ids: Array<string>

Associated transaction IDs.

external_id?: string

User-provided unique ID when the payment was created with one.