Preview

Create an Account Link

Creates an Account Link containing a short-lived, single-use Paypercut URL. Redirect the connected account's representative to this URL to start or resume hosted onboarding.

If the link expires or cannot be used, send the representative to refresh_url, where your integration must create a new Account Link before redirecting them again. Reaching return_url does not mean onboarding or verification is complete.

Headers

Idempotency-Key
Type: string
max length:
255

Provide a unique, stable key per operation so retries don't create duplicates. Allowed: letters, digits, colon, dash, underscore, dot. Max 255 characters.

Body·

required

application/json

Request to create an Account Link for an existing connected account.

account
Type: string
min length:
1
max length:
100
required

ID of the existing connected account to onboard.
type
enum
const:
account_onboarding
required

Account Link flow to create.
values
- account_onboarding
  
  Collects outstanding requirements through hosted onboarding.
refresh_url
Type: string
min length:
1
max length:
2048Format: uri
required

URL used when the Account Link expires or cannot be used. Your integration must create a new Account Link before redirecting the representative again.

Use an absolute HTTPS URL without user information or fragments. HTTP is accepted only for loopback hosts during local development.
return_url
Type: string
min length:
1
max length:
2048Format: uri
required

URL used when the hosted interaction ends. Reaching this URL does not mean onboarding or verification is complete.

Use an absolute HTTPS URL without user information or fragments. HTTP is accepted only for loopback hosts during local development.
collection_options
Type: object ·

Requirements to collect during hosted onboarding.
locale
Type: string
min length:
2
max length:
35

Preferred IETF language tag for hosted onboarding. When omitted, Paypercut uses the Account's default locale when available.

The locale applies when a new onboarding session is created. An active session resumes with its existing locale.

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json

post/v1/account_links

curl https://api.paypercut.io/v1/account_links \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "account": "acct_123",
  "type": "account_onboarding",
  "refresh_url": "https://example.com/connect/refresh",
  "return_url": "https://example.com/connect/return",
  "collection_options": {
    "fields": "currently_due"
  },
  "locale": "en-GB"
}'

Show Schema

{
  "object": "account_link",
  "created": "2026-09-15T09:00:00Z",
  "expires_at": "2026-09-15T09:10:00Z",
  "url": "https://connect.paypercut.io/setup/c/acct_123/example-token"
}

Account Link created successfully.