Moov.Underwriting (Moov v1.0.0)

Copy Markdown View Source

Submit underwriting details for a business account - e.g. average transaction size, expected annual revenue/card volume, and whether the business is a money services business.

See https://docs.moov.io/api/moov-accounts/underwriting/.

Summary

Functions

Creates or updates underwriting details for an account. This is the preferred entry point - update/3 (PUT) is being sunset in favor of calling this repeatedly as details change.

Retrieves underwriting details for an account.

Updates underwriting details via PUT.

Functions

create_or_update(client, account_id, params)

@spec create_or_update(Moov.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Creates or updates underwriting details for an account. This is the preferred entry point - update/3 (PUT) is being sunset in favor of calling this repeatedly as details change.

params typically includes :average_transaction_amount, :max_transaction_amount, :volume_by_customer_type, :average_monthly_transaction_volume, :volume_by_payment_type, :cards_volume_5_percent_or_more and similar fields - see the Moov dashboard's underwriting requirements for the exact set for your account type.

get(client, account_id)

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

Retrieves underwriting details for an account.

update(client, account_id, params)

@spec update(Moov.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Updates underwriting details via PUT.

Deprecated

Moov is sunsetting this endpoint - prefer create_or_update/3.