The AccountLink object

Attributes

objectstring, value is "v2.core.account_link"
String representing the object’s type. Objects of the same type share the same value of the object field.

accountstring
The ID of the Account the link was created for.

createdtimestamp
The timestamp at which this AccountLink was created.

expires_attimestamp
The timestamp at which this AccountLink will expire.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

urlstring
The URL for the AccountLink.

use_caseobject
The use case of AccountLink the user is requesting.

The AccountLink object

{
  "object": "v2.core.account_link",
  "account": "acct_1Nv0FGQ9RKHgCVdK",
  "created": "2025-03-27T17:15:18.000Z",
  "expires_at": "2025-03-27T17:25:18.000Z",
  "url": "https://accounts.stripe.com/r/acct_1Nv0FGQ9RKHgCVdK#alu_test_61SGhyomRuz7xsw5216SGhyj0ASQdCLwMKdRUF3mi3H6",
  "use_case": {
    "account_onboarding": {
      "configurations": [
        "recipient"
      ],
      "refresh_url": "https://example.com/reauth",
      "return_url": "https://example.com/return"
    },
    "type": "account_onboarding"
  }
}

Create an Account Link v2

Creates an AccountLink object that includes a single-use Stripe URL that the merchant can redirect their user to in order to take them to a Stripe-hosted application such as Recipient Onboarding.

Learn more about calling API v2 endpoints.

Parameters

accountstringRequired
The ID of the Account to create link for.

use_caseobjectRequired
The use case of the AccountLink.

Returns

Response attributes

objectstring, value is "v2.core.account_link"
String representing the object’s type. Objects of the same type share the same value of the object field.

accountstring
The ID of the Account the link was created for.

createdtimestamp
The timestamp at which this AccountLink was created.

expires_attimestamp
The timestamp at which this AccountLink will expire.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

urlstring
The URL for the AccountLink.

use_caseobject
The use case of AccountLink the user is requesting.

Error Codes

400configs_must_match_to_use_account_links

Account cannot be onboard via v2/core/account_links without specifying the right configurations.

404not_found

The resource wasn’t found.

POST /v2/core/account_links

Server-side language

curl -X POST https://api.stripe.com/v2/core/account_links \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-07-30.preview" \
  --json '{
    "account": "acct_1Nv0FGQ9RKHgCVdK",
    "use_case": {
        "type": "account_onboarding",
        "account_onboarding": {
            "configurations": [
                "recipient"
            ],
            "return_url": "https://example.com/return",
            "refresh_url": "https://example.com/reauth"
        }
    }
  }'

Response

{
  "object": "v2.core.account_link",
  "account": "acct_1Nv0FGQ9RKHgCVdK",
  "created": "2025-03-27T17:15:18.000Z",
  "expires_at": "2025-03-27T17:25:18.000Z",
  "livemode": true,
  "url": "https://accounts.stripe.com/r/acct_1Nv0FGQ9RKHgCVdK#alu_test_61SGhyomRuz7xsw5216SGhyj0ASQdCLwMKdRUF3mi3H6",
  "use_case": {
    "account_onboarding": {
      "configurations": [
        "recipient"
      ],
      "refresh_url": "https://example.com/reauth",
      "return_url": "https://example.com/return"
    },
    "type": "account_onboarding"
  }
}

US Bank Accounts v2

Use the USBankAccounts API to create and manage US bank accounts objects that you can use to receive funds. Note that these are not interchangeable with v1 Tokens.

Learn more about calling API v2 endpoints.

Endpoints

POST/v2/core/vault/us_bank_accounts

POST/v2/core/vault/us_bank_accounts/:id

GET/v2/core/vault/us_bank_accounts/:id

POST/v2/core/vault/us_bank_accounts/:id/archive