GoCardless API API Documentation
Create a Redirect Flow
POST {{url}}/redirect_flows
Please consider using the Billing Requests API instead of Redirect Flows for any future integrations. Creates a redirect flow object which can then be used to redirect your customer to the GoCardless hosted payment pages.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status Created
| {
"redirect_flows": {
"id": "RE00065090KJ6MDFER2C70QAXXHNHMTM",
"description": "Wine boxes",
"session_token": "SESS_9095ad21-a48b-4eec-af1e-bc23b50fbcb8",
"scheme": "bacs",
"success_redirect_url": "https://example.com/pay/confirm",
"created_at": "2024-03-22T20:29:05.480Z",
"links": {
"creditor": "CR00006C6DF0TD",
"billing_request": "BRQ0005Y9HKHDD9"
},
"metadata": {},
"redirect_url": "https://pay-sandbox.gocardless.com/billing/static/flow?id=BRF0002KAT8JTRMB8QRT53P93TH3NAVB"
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/redirect_flows' -d '{"redirect_flows":{"description":"Wine boxes","session_token":"SESS_$randomUUID","success_redirect_url":"https://example.com/pay/confirm","prefilled_customer":{"given_name":"$randomUUID","family_name":"$randomUUID","email":"$randomUUID"}}}'
ENDPOINTS