Payment Flows
Gets a payment flow by ID or external ID.
get/payment-flows/{payment_flow_ref}
Path parameters
payment_flow_refstring required
Payment flow ID or external ID.
Example:pf_abc123
Response
Success
Example response
{
"data": {
"id": "pf_abc123",
"type": "single_invoice_settlement",
"status": "settled",
"external_id": "pf_123",
"invoice": {
"id": "inv_abc123",
"external_id": "inv_ext_123"
},
"payment_plan": {
"version": 1,
"invoice_id": "inv_abc123",
"generated_at": "2024-01-01T00:00:00.000Z",
"batches": [
{
"batch_id": "payins",
"label": "Payins",
"depends_on": [],
"status": "settled",
"payments": [
{
"payment_id": "pmt_abc123",
"user": {
"id": "user_abc123",
"external_id": "user_ext_001"
},
"direction": "payin",
"amount": "10000",
"currency": "USD",
"status": "settled"
}
]
}
]
},
"created": "2024-01-01T00:00:00.000Z",
"modified": "2024-01-01T00:00:00.000Z"
}
}