---
title: "$viva->bankAccounts->link()"
method: POST
path: "/BankAccounts/link"
tags: ["BankAccounts"]
---

# $viva->bankAccounts->link()

`POST /BankAccounts/link`

## Request

- The document declares no server URL.
- Auth: none declared
- TypeScript: <https://skmtc.dev/qrcommunication/apis/viva-wallet-merchant-sdk-re-fe-rence-php/docs/BankAccounts/link/post.ts> (a function with typed inputs; its response is checked against the schema)

Lie un compte bancaire (validation IBAN + enregistrement).

```php
$result = $viva->bankAccounts->link(
    iban: 'FR7630006000011234567890189',
    beneficiaryName: 'Jean Dupont',
    friendlyName: 'Compte principal',
);

echo $result['bankAccountId']; // UUID
echo $result['isVivaIban'];    // false (IBAN externe)
```

## Request body

- BankAccountLinkParams
  - `iban` string, required: IBAN du compte bancaire
  - `beneficiaryName` string, required: Nom du titulaire du compte
  - `friendlyName` string, nullable: Nom d'affichage optionnel

## Response `200`

Compte bancaire lié

- BankAccountLinkResult
  - `bankAccountId` string, uuid: UUID du compte bancaire lié
  - `isVivaIban` boolean: L'IBAN appartient-il à un compte Viva interne ?

## Changes

- **2026-03-18** `b25ecb15a272`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/qrcommunication/apis/viva-wallet-merchant-sdk-re-fe-rence-php/changes/BankAccounts/link/post.md)

---

[API](https://skmtc.dev/qrcommunication/apis/viva-wallet-merchant-sdk-re-fe-rence-php.md) - [All operations](https://skmtc.dev/qrcommunication/apis/viva-wallet-merchant-sdk-re-fe-rence-php/llms.txt) - [OpenAPI document](https://skmtc.dev/qrcommunication/apis/viva-wallet-merchant-sdk-re-fe-rence-php/revisions/bcafd06ce584?raw)