# `AdyenClient.BalancePlatform`
[🔗](https://github.com/iamkanishka/adyen_client/blob/v1.0.0/lib/adyen_client/platforms.ex#L434)

Adyen Balance Platform Configuration API (v2).

Manages balance platforms, account holders, balance accounts, payment instruments,
transaction rules, sweeps, card PINs, SCA devices, mandates, and transfer limits.

# `amend_mandate`

```elixir
@spec amend_mandate(String.t(), map(), keyword()) :: AdyenClient.Client.response()
```

Amend a mandate.

# `calculate_transfer_routes`

```elixir
@spec calculate_transfer_routes(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

Calculate transfer routes.

# `cancel_mandate`

```elixir
@spec cancel_mandate(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Cancel a mandate.

# `change_pin`

```elixir
@spec change_pin(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

Change a card PIN.

# `complete_sca_device_registration`

```elixir
@spec complete_sca_device_registration(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

Complete SCA device registration.

# `create_account_holder`

```elixir
@spec create_account_holder(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

Create an account holder.

# `create_authorized_card_users`

```elixir
@spec create_authorized_card_users(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

Create authorized users for a card.

# `create_balance_account`

```elixir
@spec create_balance_account(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

Create a balance account.

# `create_balance_account_limit`

```elixir
@spec create_balance_account_limit(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

Create a transfer limit for a balance account.

# `create_network_token_activation_data`

```elixir
@spec create_network_token_activation_data(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

Create network token provisioning data.

# `create_payment_instrument`

```elixir
@spec create_payment_instrument(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

Create a payment instrument (card or bank account).

# `create_sweep`

```elixir
@spec create_sweep(String.t(), map(), keyword()) :: AdyenClient.Client.response()
```

Create a sweep on a balance account.

# `create_transaction_rule`

```elixir
@spec create_transaction_rule(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

Create a transaction rule.

# `delete_authorized_card_users`

```elixir
@spec delete_authorized_card_users(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Delete authorized users for a card.

# `delete_balance_account_limit`

```elixir
@spec delete_balance_account_limit(String.t(), String.t(), keyword()) ::
  AdyenClient.Client.response()
```

Delete a transfer limit for a balance account.

# `delete_sca_device`

```elixir
@spec delete_sca_device(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Delete an SCA device registration.

# `delete_sweep`

```elixir
@spec delete_sweep(String.t(), String.t(), keyword()) :: AdyenClient.Client.response()
```

Delete a sweep.

# `delete_transaction_rule`

```elixir
@spec delete_transaction_rule(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Delete a transaction rule.

# `get`

```elixir
@spec get(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get a balance platform.

# `get_account_holder`

```elixir
@spec get_account_holder(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get an account holder.

# `get_authorized_card_users`

```elixir
@spec get_authorized_card_users(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get authorized users for a card.

# `get_balance_account`

```elixir
@spec get_balance_account(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get a balance account.

# `get_card_order_items`

```elixir
@spec get_card_order_items(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get items in a card order.

# `get_grant_account`

```elixir
@spec get_grant_account(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get a grant account.

# `get_grant_offer`

```elixir
@spec get_grant_offer(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get a specific grant offer.

# `get_mandate`

```elixir
@spec get_mandate(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get a specific mandate.

# `get_network_token`

```elixir
@spec get_network_token(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get a network token.

# `get_network_token_activation_data`

```elixir
@spec get_network_token_activation_data(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get network token activation data.

# `get_pan`

```elixir
@spec get_pan(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get the PAN of a payment instrument.

# `get_payment_instrument`

```elixir
@spec get_payment_instrument(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get a payment instrument.

# `get_public_key`

```elixir
@spec get_public_key(keyword()) :: AdyenClient.Client.response()
```

Get the RSA public key for PIN encryption.

# `get_sweep`

```elixir
@spec get_sweep(String.t(), String.t(), keyword()) :: AdyenClient.Client.response()
```

Get a sweep.

# `get_tax_form`

```elixir
@spec get_tax_form(String.t(), map(), keyword()) :: AdyenClient.Client.response()
```

Get a tax form for an account holder.

# `get_transaction_rule`

```elixir
@spec get_transaction_rule(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get a transaction rule.

# `list_account_holders`

```elixir
@spec list_account_holders(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

List account holders under a balance platform.

# `list_balance_account_limits`

```elixir
@spec list_balance_account_limits(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

List transfer limits for a balance account.

# `list_balance_accounts`

```elixir
@spec list_balance_accounts(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get all balance accounts of an account holder.

# `list_card_orders`

```elixir
@spec list_card_orders(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

List card orders.

# `list_grant_offers`

```elixir
@spec list_grant_offers(keyword()) :: AdyenClient.Client.response()
```

List available grant offers.

# `list_mandates`

```elixir
@spec list_mandates(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

List mandates.

# `list_network_tokens`

```elixir
@spec list_network_tokens(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

List network tokens for a payment instrument.

# `list_payment_instruments`

```elixir
@spec list_payment_instruments(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

Get payment instruments linked to a balance account.

# `list_sca_devices`

```elixir
@spec list_sca_devices(keyword()) :: AdyenClient.Client.response()
```

List registered SCA devices.

# `list_sweeps`

```elixir
@spec list_sweeps(
  String.t(),
  keyword()
) :: AdyenClient.Client.response()
```

List sweeps for a balance account.

# `register_sca_device`

```elixir
@spec register_sca_device(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

Initiate SCA device registration.

# `reveal_payment_instrument`

```elixir
@spec reveal_payment_instrument(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

Reveal the full data of a payment instrument.

# `reveal_pin`

```elixir
@spec reveal_pin(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

Reveal a card PIN.

# `update_account_holder`

```elixir
@spec update_account_holder(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

Update an account holder.

# `update_authorized_card_users`

```elixir
@spec update_authorized_card_users(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

Update authorized users for a card.

# `update_balance_account`

```elixir
@spec update_balance_account(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

Update a balance account.

# `update_network_token`

```elixir
@spec update_network_token(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

Update a network token.

# `update_payment_instrument`

```elixir
@spec update_payment_instrument(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

Update a payment instrument.

# `update_sweep`

```elixir
@spec update_sweep(String.t(), String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

Update a sweep.

# `update_transaction_rule`

```elixir
@spec update_transaction_rule(String.t(), map(), keyword()) ::
  AdyenClient.Client.response()
```

Update a transaction rule.

# `validate_bank_account`

```elixir
@spec validate_bank_account(
  map(),
  keyword()
) :: AdyenClient.Client.response()
```

Validate a bank account.

---

*Consult [api-reference.md](api-reference.md) for complete listing*