API Docs / Operations / Billing / Complete Mandate Setup

Complete Mandate Setup

PUT /me/billing/mandate

Completes a Direct Debit setup the customer has finished on GoCardless: the redirect_flow_id GoCardless appended to the success URL. Returns the mandate as GET does; invoices waiting for a mandate are then collected by Account Hub.

Request Body*

CompleteMandateSetupRequest
{
  "redirectFlowId": "string"
}

Responses

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

Try it

Related Schemas

CompleteMandateSetupRequest

Completes a Direct Debit setup the customer has finished on GoCardless (`PUT /me/billing/mandate`).

BillingMandateDto

The caller's Direct Debit mandate, refreshed from GoCardless through Account Hub.

HttpValidationProblemDetails

ProblemDetails