Flows
Create a Flow
All requests to the /v2/flow/*
endpoints must include both the client_id
and api_key
as detailed in the
Authentication document.
Creates a new Flow.
Method
Make a request to the /v2/flow/create endpoint
Request Example
curl https://pls.senddotssandbox.com/v2/flow/create \
-X POST \
-H "Authorization: Basic <TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"steps": ["compliance", "manage-payouts", "payout"],
}'
response = {
"success": "true",
"flow": {
"id": "5f0f8f8f-f8f8-f8f8-f8f8-f8f8f8f8f8f8",
"created": "2020-12-09T00:40:51.107Z",
"updated": "2020-12-09T00:40:51.107Z",
"user_id": null,
"steps": ["compliance", "manage-payouts", "payout"],
"completed_steps": [],
"payout_link_id": null,
"link": "https://my.senddotssandbox.com/flow/5f0f8f8f-f8f8-f8f8-f8f8-f8f8f8f8f8f8"
}
}
Parameters
Name | Type | Required | Description |
---|---|---|---|
steps | list[string] | ✔️ | List of steps. Step is one of [compliance, manage-payments, manage-payouts, payout] |
user_id | string (uuid) | User to pre-authenticte the flow for |
Styling
Flow styling will be supported in the future.