Retrieve a Flow
users
transfers
payout-links
payments
payment-intents
payment-customers
checkout-sessions
accounts-payable
- GETList all vendors
- POSTCreate a vendor
- GETGet vendor details
- DELDelete a vendor
- GETList all payment methods for a vendor
- POSTCreate a payment method for a vendor
- GETGet vendor payment method details
- DELDelete a vendor payment method
- GETList all payables
- POSTCreate a payable
- POSTCreate a payable from a file
- GETGet payable details
- PATCHUpdate a payable
- POSTUpload file to the payable
- DELDelete file from the payable
- POSTCancel a payable
- POSTSubmit a payable for approval
- POSTApprove a payable
- POSTReject a payable
- POSTPay a payable
- GETList all approval policies
- POSTCreate an approval policy
- DELDelete an approval policy
- PATCHUpdate priority of an approval policy
- GETList all approvers for api app
apps
payment-methods
organizations
Retrieve a Flow
All requests to the /v2/flow/*
endpoints must include both the client_id
and api_key
as detailed in the
Authentication document.
Get an flow by its ID
Method
Make a request to /v2/flow/get/
Request Example
curl https://pls.senddotssandbox.com/v2/flow/get/5f0f8f8f-f8f8-f8f8-f8f8-f8f8f8f8f8f8 \
-H "Authorization: Basic <TOKEN>" \
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": "12345678-f8f8-f8f8-f8f8-f8f8f8f8f8f8",
"steps": ["compliance", "manage-payouts", "payout"],
"completed_steps": ["compliance", "manage-payouts"],
"payout_link_id": null,
"link": "https://my.senddotssandbox.com/flow/5f0f8f8f-f8f8-f8f8-f8f8-f8f8f8f8f8f8"
}
}
On this page