GoCardlessClient.Resources.BankAccountDetails (GoCardlessClient v2.0.0)

GoCardless Bank Account Details API.

Returns encrypted bank account details (sort code + account number or IBAN) for a customer bank account. Requires special approval from GoCardless — not available by default.

The response includes encrypted_data and encrypted_key fields that must be decrypted using asymmetric key decryption on your side.

Example

{:ok, details} = GoCardlessClient.Resources.BankAccountDetails.get(
  client,
  %{"links[customer_bank_account]" => "BA123"}
)

Summary

Functions

get(client, params \\ %{}, opts \\ [])

Returns encrypted bank details for a customer bank account.

Functions

get(client, params \\ %{}, opts \\ [])

@spec get(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Returns encrypted bank details for a customer bank account.

Pass %{"links[customer_bank_account]" => "BA123"} as params.