Create an account link

POST /v1/account_links

Copy endpoint

https://api.stripe.com/

Request Body

application/x-www-form-urlencoded required

{
account: string;
collect?: "currently_due" | "eventually_due";
collection_options?: { fields?: "currently_due" | "eventually_due";future_requirements?: "include" | "omit"; };
expand?: string[];
refresh_url?: string;
return_url?: string;
type: "account_onboarding" | "account_update";
}

Responses

200 application/json

Successful response.

interface AccountLink {
created: number;
expires_at: number;
object: "account_link";
url: string;
}

default application/json

Error response.

interface Error {
error:

ApiErrors

interface ApiErrors {
advice_code?: string;
charge?: string;
code?: string;
decline_code?: string;
doc_url?: string;
message?: string;
network_advice_code?: string;
network_decline_code?: string;
param?: string;
payment_intent?: PaymentIntent;
payment_method?: PaymentMethod;
payment_method_type?: string;
request_log_url?: string;
setup_intent?: SetupIntent;
source?: BankAccount | Card | Source;
type: "api_error" | "card_error" | "idempotency_error" | "invalid_request_error";
}

;
}