API Docs / Operations / Billing / Create Mandate Setup

Create Mandate Setup

POST /me/billing/mandate-setups

Starts a direct debit setup with GoCardless. Send the customer's browser to the returned redirectUrl; GoCardless sends it back to the successRedirectUrl with redirect_flow_id appended, and the client completes the setup with PUT /me/billing/mandate, passing the session token it was given here. 409 when the caller already has an active or in-progress mandate; 400 when the caller has no email address or GoCardless refused.

{
  "successRedirectUrl": "https://example.com"
}

Responses

201 Created
400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
409 Conflict
application/problem+json