GoCardlessClient.Resources.BankAccountHolderVerifications (GoCardlessClient v2.0.0)

Copy Markdown View Source

GoCardless Bank Account Holder Verifications API (Confirmation of Payee).

Verifies that a bank account holder name matches an expected value before sending money. Useful for fraud prevention in Outbound Payment flows.

Example

{:ok, verification} = GoCardlessClient.Resources.BankAccountHolderVerifications.create(
  client,
  %{
    account_holder_name: "Alice Smith",
    sort_code: "200000",
    account_number: "55779911"
  }
)

case verification["result"] do
  "pass" -> :proceed
  "fail" -> :abort
  "inconclusive" -> :manual_review
end

Summary

Functions

create(client, params, opts \\ [])

Creates a bank account holder verification (Confirmation of Payee).

get(client, id, opts \\ [])

Retrieves a single bank account holder verification by ID.

Functions

create(client, params, opts \\ [])

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

Creates a bank account holder verification (Confirmation of Payee).

Params (provide one of: sort_code + account_number, or iban)

  • :account_holder_name — the name to verify (required)
  • :sort_code — UK sort code 6 digits
  • :account_number — UK account number 8 digits
  • :iban — IBAN for SEPA accounts

get(client, id, opts \\ [])

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

Retrieves a single bank account holder verification by ID.