/* * 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"; /** * Instant micro-deposit verification offers a quick and efficient way to verify bank account ownership. * * Send a $0.01 credit with a unique verification code via RTP, FedNow, or same-day ACH, depending on the receiving bank's capabilities. This * feature provides a faster alternative to traditional methods, allowing verification in a single session. * * It is recommended to use the `X-Wait-For: rail-response` header to synchronously receive the outcome of the instant credit in the * response payload. * * Possible verification methods: * - `instant`: Real-time verification credit sent via RTP or FedNow * - `ach`: Verification credit sent via same-day ACH * * Possible statuses: * - `new`: Verification initiated, credit pending * - `sent-credit`: Credit sent, available for verification in the external bank account * - `failed`: Verification failed due to credit rejection/return, details in `exceptionDetails` * * 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 bankAccountsInitiateVerification( client: MoovCore, request: operations.InitiateBankAccountVerificationRequest, options?: RequestOptions, ): APIPromise< Result< operations.InitiateBankAccountVerificationResponse, | errors.GenericError | MoovError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError > > { return new APIPromise($do( client, request, options, )); } async function $do( client: MoovCore, request: operations.InitiateBankAccountVerificationRequest, options?: RequestOptions, ): Promise< [ Result< operations.InitiateBankAccountVerificationResponse, | errors.GenericError | MoovError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >, APICall, ] > { const parsed = safeParse( request, (value) => operations.InitiateBankAccountVerificationRequest$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}/verify", )(pathParams); const headers = new Headers(compactMap({ Accept: "application/json", "X-Moov-Version": encodeSimple( "X-Moov-Version", client._options.xMoovVersion, { explode: false, charEncoding: "none" }, ), "x-wait-for": encodeSimple("x-wait-for", payload["x-wait-for"], { 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: "initiateBankAccountVerification", 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.InitiateBankAccountVerificationResponse, | errors.GenericError | MoovError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >( M.json( 200, operations.InitiateBankAccountVerificationResponse$inboundSchema, { hdrs: true, key: "Result" }, ), 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 }]; }