/* * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ import { MoovCore } from "../core.js"; import { encodeSimple } from "../lib/encodings.js"; import * as M from "../lib/matchers.js"; import { compactMap } from "../lib/primitives.js"; import { safeParse } from "../lib/schemas.js"; import { RequestOptions } from "../lib/sdks.js"; import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; import { pathToFunc } from "../lib/url.js"; import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError, } from "../models/errors/httpclienterrors.js"; import * as errors from "../models/errors/index.js"; import { MoovError } from "../models/errors/mooverror.js"; import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { APICall, APIPromise } from "../types/async.js"; import { Result } from "../types/fp.js"; /** * Micro-deposits help confirm bank account ownership, helping reduce fraud and the risk of unauthorized activity. * Use this method to initiate the micro-deposit verification, sending two small credit transfers to the bank account * you want to confirm. * * If you request micro-deposits before 4:15PM ET, they will appear that same day. If you request micro-deposits any * time after 4:15PM ET, they will appear the next banking day. When the two credits are initiated, Moov simultaneously * initiates a debit to recoup the micro-deposits. * * Micro-deposits initiated for a `sandbox` bank account will always be `$0.00` / `$0.00` and instantly verifiable once initiated. * * You can simulate micro-deposit verification in test mode. See our [test mode](https://docs.moov.io/guides/get-started/test-mode/#micro-deposits) * guide for more information. * * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) * you'll need to specify the `/accounts/{accountID}/bank-accounts.write` scope. */ export function bankAccountsInitiateMicroDeposits( client: MoovCore, request: operations.InitiateMicroDepositsRequest, options?: RequestOptions, ): APIPromise< Result< operations.InitiateMicroDepositsResponse | undefined, | errors.GenericError | MoovError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError > > { return new APIPromise($do( client, request, options, )); } async function $do( client: MoovCore, request: operations.InitiateMicroDepositsRequest, options?: RequestOptions, ): Promise< [ Result< operations.InitiateMicroDepositsResponse | undefined, | errors.GenericError | MoovError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >, APICall, ] > { const parsed = safeParse( request, (value) => operations.InitiateMicroDepositsRequest$outboundSchema.parse(value), "Input validation failed", ); if (!parsed.ok) { return [parsed, { status: "invalid" }]; } const payload = parsed.value; const body = null; const pathParams = { accountID: encodeSimple("accountID", payload.accountID, { explode: false, charEncoding: "percent", }), bankAccountID: encodeSimple("bankAccountID", payload.bankAccountID, { explode: false, charEncoding: "percent", }), }; const path = pathToFunc( "/accounts/{accountID}/bank-accounts/{bankAccountID}/micro-deposits", )(pathParams); const headers = new Headers(compactMap({ Accept: "application/json", "X-Moov-Version": encodeSimple( "X-Moov-Version", client._options.xMoovVersion, { explode: false, charEncoding: "none" }, ), })); const securityInput = await extractSecurity(client._options.security); const requestSecurity = resolveGlobalSecurity(securityInput); const context = { options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "initiateMicroDeposits", oAuth2Scopes: null, resolvedSecurity: requestSecurity, securitySource: client._options.security, retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], }; const requestRes = client._createRequest(context, { security: requestSecurity, method: "POST", baseURL: options?.serverURL, path: path, headers: headers, body: body, userAgent: client._options.userAgent, timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, }, options); if (!requestRes.ok) { return [requestRes, { status: "invalid" }]; } const req = requestRes.value; const doResult = await client._do(req, { context, errorCodes: [ "400", "401", "403", "404", "409", "429", "4XX", "500", "504", "5XX", ], retryConfig: context.retryConfig, retryCodes: context.retryCodes, }); if (!doResult.ok) { return [doResult, { status: "request-error", request: req }]; } const response = doResult.value; const responseFields = { HttpMeta: { Response: response, Request: req }, }; const [result] = await M.match< operations.InitiateMicroDepositsResponse | undefined, | errors.GenericError | MoovError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >( M.nil( 204, operations.InitiateMicroDepositsResponse$inboundSchema.optional(), { hdrs: true }, ), M.jsonErr([400, 409], errors.GenericError$inboundSchema, { hdrs: true }), M.fail([401, 403, 404, 429]), M.fail([500, 504]), M.fail("4XX"), M.fail("5XX"), )(response, req, { extraFields: responseFields }); if (!result.ok) { return [result, { status: "complete", request: req, response }]; } return [result, { status: "complete", request: req, response }]; }