Create a link to add a Plaid or card account

POST

accounts

link

const options = {
  method: 'POST',
  headers: {
    'Melio-Entity-Id': '<melio-entity-id>',
    'api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({type: 'plaid'})
};

fetch('https://api.melio.com/v2/accounts/link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "url": "https://portal.melio.com/payouts/link?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
    "expiration": "2026-07-08T16:04:05Z"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "BUSINESS_NOT_ELIGIBLE",
    "message": "Business is not eligible to add an internal account. See the limitations endpoint for details."
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  }
}

Authorizations

api-key

string

header

required

Headers

Melio-Sonar-Token

string

Signed MelioSonar session token from the initiating device, used for risk evaluation; invalid or expired tokens return 403.

Melio-Entity-Id

string

required

Entity the request operates on — an entity id (ent_<uuid>) or me (the partner's sole entity).

Body

application/json

type

enum<string>

required

Available options:

plaid,

card

externalId

string

Your own unique identifier for the account. When set, the account created through this link is pinned to this externalId; the submitter cannot supply a different one.

Maximum string length: 255

Pattern: ^[A-Za-z0-9_-]+$

Response

Link created.

data

object

Hide child attributes

data.url

string

Portal URL the entity opens to add the account (the scoped session JWT is embedded as ?token=)

data.expiration

string<date-time>

⌘I

const options = {
  method: 'POST',
  headers: {
    'Melio-Entity-Id': '<melio-entity-id>',
    'api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({type: 'plaid'})
};

fetch('https://api.melio.com/v2/accounts/link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "url": "https://portal.melio.com/payouts/link?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
    "expiration": "2026-07-08T16:04:05Z"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "BUSINESS_NOT_ELIGIBLE",
    "message": "Business is not eligible to add an internal account. See the limitations endpoint for details."
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  }
}

Entities

Accounts

Payments

Tools

Webhooks

Create a link to add a Plaid or card account

Authorizations

Headers

Body

Response