Payment Flows

Payment flow operations

Create

POST/payment-flows

Retrieve

GET/payment-flows/{payment_flow_ref}

Search

POST/payment-flows/search

ModelsExpand Collapse

PaymentFlow object { 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: object { id, external_id }

Invoice being settled.

id: string

Invoice identifier.

external_id: optional string

Invoice external ID.

modified: string

Timestamp when the payment flow was last modified.

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

Payment plan for UI rendering.

batches: array of object { batch_id, depends_on, label, 2 more }

Payment batches.

batch_id: string

Batch identifier.

depends_on: array of string

Batches this one depends on.

label: string

Human-readable batch label.

payments: array of object { amount, currency, direction, 3 more }

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: object { 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 object { 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: object { id, external_id }

Invoice being settled.

id: string

Invoice identifier.

external_id: optional string

Invoice external ID.

modified: string

Timestamp when the payment flow was last modified.

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

Payment plan for UI rendering.

batches: array of object { batch_id, depends_on, label, 2 more }

Payment batches.

batch_id: string

Batch identifier.

depends_on: array of string

Batches this one depends on.

label: string

Human-readable batch label.

payments: array of object { amount, currency, direction, 3 more }

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: object { 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 object { 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: object { id, external_id }

Invoice being settled.

id: string

Invoice identifier.

external_id: optional string

Invoice external ID.

modified: string

Timestamp when the payment flow was last modified.

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

Payment plan for UI rendering.

batches: array of object { batch_id, depends_on, label, 2 more }

Payment batches.

batch_id: string

Batch identifier.

depends_on: array of string

Batches this one depends on.

label: string

Human-readable batch label.

payments: array of object { amount, currency, direction, 3 more }

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: object { 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 object { data }

List of payment flows.

data: array of 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: object { id, external_id }

Invoice being settled.

id: string

Invoice identifier.

external_id: optional string

Invoice external ID.

modified: string

Timestamp when the payment flow was last modified.

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

Payment plan for UI rendering.

batches: array of object { batch_id, depends_on, label, 2 more }

Payment batches.

batch_id: string

Batch identifier.

depends_on: array of string

Batches this one depends on.

label: string

Human-readable batch label.

payments: array of object { amount, currency, direction, 3 more }

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: object { 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.