Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
external-accounts
/
link
Generate External Account Link
curl --request POST \
  --url https://api.cadanapay.com/v1/businesses/{businessId}/external-accounts/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refreshURL": "<string>",
  "returnURL": "<string>",
  "mode": "standard"
}
'
{
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

​
businessId
string
required

The unique identifier for the business

Body

application/json
​
refreshURL
string

The URL the user will be redirected to if the link is expired

​
returnURL
string

The URL that the user will be redirected to upon leaving or completing the linked flow.

​
mode
enum<string>
default:standard

Controls the account linking behavior. "standard" shows the entry page with "Add payment method" button. "setup" skips the entry page and goes directly to bank selection flow.

Available options:
standard,
setup

Response

generate link for external account response

​
url
string