@spec accrue_interest(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Trigger interest accrual on a deposit account.

@spec advance_received_payment(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Advance a received ACH payment (simulate early-access to incoming funds).

Required params

• :received_payment_id

@spec approve_application(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Approve an application in the sandbox.

@spec approve_document(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

Approve an application document.

@spec atm_withdrawal(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate an ATM withdrawal.

Required params

• :card_id, :amount, :atm_name

Optional

• :atm_location, :surcharge

@spec authorize_card(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate a card purchase authorization (creates a pending Authorization).

Required params

• :card_id, :amount

Optional

• :merchant (%{name:, type:, category:, location:}), :recurring, :tags

@spec change_credit_limit(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate a credit limit change on a credit account.

Required params

• :credit_account_id, :credit_limit (new limit in cents)

@spec clear_ach(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate an ACH payment clearing (Pending → Sent).

Required params

• :payment_id

@spec clear_check_deposit(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate clearing a check deposit (AwaitingImages → Clearing → Sent).

Required params

• :check_deposit_id

Optional

• :status — "Clearing" (default) or "Sent"

@spec decline_authorization(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate a card authorization being declined.

Required params

• :card_id, :amount, :reason

Optional

• :merchant

@spec deny_application(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Deny an application in the sandbox.

@spec generate_statement(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Generate a monthly statement for an account in sandbox.

@spec process_check_payment(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate a check payment being processed (New/Pending → Processed).

Required params

• :check_payment_id

@spec purchase_card(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate a settled card purchase (no authorization step).

Required params

• :card_id, :amount

Optional

• :merchant, :tags

@spec receive_ach(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate receiving an incoming ACH payment.

Required params

• :account_id, :amount, :direction ("Credit" or "Debit"), :description

Optional

• :sec_code, :counterparty, :same_day, :tags

@spec receive_wire(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate receiving an incoming wire payment.

Required params

• :account_id, :amount, :description

Optional

• :originating_fi, :tags

@spec reject_check_deposit(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate rejecting a check deposit.

Required params

• :check_deposit_id, :reason

@spec reject_document(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

Reject an application document.

@spec require_review_document(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

Set an application document to RequireAdditionalReview.

@spec return_ach(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate an ACH payment being returned.

Fires the payment.returned webhook and creates a Returned ACH Transaction.

Required params

• :payment_id
• :return_reason_code — e.g. "R01" (NSF), "R02" (closed), "R10" (unauthorized)

@spec return_check_deposit(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate returning a cleared check deposit.

Required params

• :check_deposit_id, :reason

@spec return_check_payment(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate a check payment being returned.

Required params

• :check_payment_id, :return_reason

@spec reverse_card(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate a card reversal.

Required params

• :amount
• :authorization_id OR :transaction_id

@spec simulate_nsf(
  map(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Simulate an NSF event on an account.

Required params

• :account_id, :amount