# TestSimulation (*testSimulation*) ## Overview ### Available Operations * [simulateCreateCheckDeposit](#simulatecreatecheckdeposit) - Simulate Check Deposit Creation * [forceApproveCheckDeposit](#forceapprovecheckdeposit) - Check Deposit Approval * [forceApproveAchDeposit](#forceapproveachdeposit) - ACH Deposit Approval * [forceNocAchDeposit](#forcenocachdeposit) - NOC for a Deposit * [forceRejectAchDeposit](#forcerejectachdeposit) - ACH Deposit Rejection * [forceReturnAchDeposit](#forcereturnachdeposit) - ACH Deposit Return * [forceApproveAchWithdrawal](#forceapproveachwithdrawal) - ACH Withdrawal Approval * [forceNocAchWithdrawal](#forcenocachwithdrawal) - ACH Withdrawal NOC * [forceRejectAchWithdrawal](#forcerejectachwithdrawal) - ACH Withdrawal Rejection * [forceReturnAchWithdrawal](#forcereturnachwithdrawal) - ACH Withdrawal Return * [getMicroDepositAmounts](#getmicrodepositamounts) - Get Relationship Micro Deposit Verification * [forceApproveIctDeposit](#forceapproveictdeposit) - Force Approve ICT Deposit * [forceRejectIctDeposit](#forcerejectictdeposit) - Force Reject ICT Deposit * [forceApproveIctWithdrawal](#forceapproveictwithdrawal) - Force Approve ICT Withdrawal * [forceRejectIctWithdrawal](#forcerejectictwithdrawal) - Force Reject ICT Withdrawal * [forceApproveWireWithdrawal](#forceapprovewirewithdrawal) - Force Approve Wire Withdrawal * [forceRejectWireWithdrawal](#forcerejectwirewithdrawal) - Force Reject Wire Withdrawal * [simulateWireDeposit](#simulatewiredeposit) - Simulate Wire Deposit * [forceApproveWireDeposit](#forceapprovewiredeposit) - Force Approve Wire Deposit * [forceRejectWireDeposit](#forcerejectwiredeposit) - Force Reject Wire Deposit * [forceApproveCashJournal](#forceapprovecashjournal) - Force Approve Cash Journal * [forceRejectCashJournal](#forcerejectcashjournal) - Force Reject Cash Journal * [forceApprovePositionJournal](#forceapprovepositionjournal) - Force Approve Position Journal * [forceRejectPositionJournal](#forcerejectpositionjournal) - Force Reject Position Journal ## simulateCreateCheckDeposit Creates a check deposit for a specific account FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.simulateCreateCheckDeposit({ amount: {}, parent: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationSimulateCreateCheckDeposit } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationSimulateCreateCheckDeposit.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationSimulateCreateCheckDeposit(apexascend, { amount: {}, parent: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationSimulateCreateCheckDeposit failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `simulateCreateCheckDepositRequestCreate` | [components.SimulateCreateCheckDepositRequestCreate](../../models/components/simulatecreatecheckdepositrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.CheckDepositsSimulateCreateCheckDepositResponse](../../models/operations/checkdepositssimulatecreatecheckdepositresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceApproveCheckDeposit Force approval of an existing check deposit that is pending review FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceApproveCheckDeposit({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/checkDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceApproveCheckDeposit } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceApproveCheckDeposit.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceApproveCheckDeposit(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/checkDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceApproveCheckDeposit failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `checkDepositId` | *string* | :heavy_check_mark: | The checkDeposit id. | [object Object] | | `forceApproveCheckDepositRequestCreate` | [components.ForceApproveCheckDepositRequestCreate](../../models/components/forceapprovecheckdepositrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.CheckDepositsForceApproveCheckDepositResponse](../../models/operations/checkdepositsforceapprovecheckdepositresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceApproveAchDeposit Forces approval of an existing ACH deposit that is pending review. FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceApproveAchDeposit({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceApproveAchDeposit } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceApproveAchDeposit.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceApproveAchDeposit(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceApproveAchDeposit failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `achDepositId` | *string* | :heavy_check_mark: | The achDeposit id. | [object Object] | | `forceApproveAchDepositRequestCreate` | [components.ForceApproveAchDepositRequestCreate](../../models/components/forceapproveachdepositrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.AchDepositsForceApproveAchDepositResponse](../../models/operations/achdepositsforceapproveachdepositresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceNocAchDeposit Forces a Nacha notice of change (NOC) on a completed ACH deposit. FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; import { Code } from "@apexfintechsolutions/ascend-sdk/models/components"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceNocAchDeposit({ nachaNoc: { code: Code.C01, }, name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceNocAchDeposit } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceNocAchDeposit.js"; import { Code } from "@apexfintechsolutions/ascend-sdk/models/components"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceNocAchDeposit(apexascend, { nachaNoc: { code: Code.C01, }, name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceNocAchDeposit failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `achDepositId` | *string* | :heavy_check_mark: | The achDeposit id. | [object Object] | | `forceNocAchDepositRequestCreate` | [components.ForceNocAchDepositRequestCreate](../../models/components/forcenocachdepositrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.AchDepositsForceNocAchDepositResponse](../../models/operations/achdepositsforcenocachdepositresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceRejectAchDeposit Forces rejection of an existing ACH deposit that is pending review. FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceRejectAchDeposit({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceRejectAchDeposit } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceRejectAchDeposit.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceRejectAchDeposit(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceRejectAchDeposit failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `achDepositId` | *string* | :heavy_check_mark: | The achDeposit id. | [object Object] | | `forceRejectAchDepositRequestCreate` | [components.ForceRejectAchDepositRequestCreate](../../models/components/forcerejectachdepositrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.AchDepositsForceRejectAchDepositResponse](../../models/operations/achdepositsforcerejectachdepositresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceReturnAchDeposit Forces a Nacha return on a completed ACH deposit. FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; import { NachaReturnCreateCode } from "@apexfintechsolutions/ascend-sdk/models/components"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceReturnAchDeposit({ nachaReturn: { code: NachaReturnCreateCode.R13, }, name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceReturnAchDeposit } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceReturnAchDeposit.js"; import { NachaReturnCreateCode } from "@apexfintechsolutions/ascend-sdk/models/components"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceReturnAchDeposit(apexascend, { nachaReturn: { code: NachaReturnCreateCode.R13, }, name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceReturnAchDeposit failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `achDepositId` | *string* | :heavy_check_mark: | The achDeposit id. | [object Object] | | `forceReturnAchDepositRequestCreate` | [components.ForceReturnAchDepositRequestCreate](../../models/components/forcereturnachdepositrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.AchDepositsForceReturnAchDepositResponse](../../models/operations/achdepositsforcereturnachdepositresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceApproveAchWithdrawal Forces approval of an existing ACH withdrawal that is pending review. FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceApproveAchWithdrawal({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achWithdrawals/20230620500726", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230620500726"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceApproveAchWithdrawal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceApproveAchWithdrawal.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceApproveAchWithdrawal(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achWithdrawals/20230620500726", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230620500726"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceApproveAchWithdrawal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `achWithdrawalId` | *string* | :heavy_check_mark: | The achWithdrawal id. | [object Object] | | `forceApproveAchWithdrawalRequestCreate` | [components.ForceApproveAchWithdrawalRequestCreate](../../models/components/forceapproveachwithdrawalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.AchWithdrawalsForceApproveAchWithdrawalResponse](../../models/operations/achwithdrawalsforceapproveachwithdrawalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceNocAchWithdrawal Forces a Nacha notice of change (NOC) on a completed ACH withdrawal. FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; import { Code } from "@apexfintechsolutions/ascend-sdk/models/components"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceNocAchWithdrawal({ nachaNoc: { code: Code.C01, }, name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achWithdrawals/20230620500726", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230620500726"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceNocAchWithdrawal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceNocAchWithdrawal.js"; import { Code } from "@apexfintechsolutions/ascend-sdk/models/components"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceNocAchWithdrawal(apexascend, { nachaNoc: { code: Code.C01, }, name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achWithdrawals/20230620500726", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230620500726"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceNocAchWithdrawal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `achWithdrawalId` | *string* | :heavy_check_mark: | The achWithdrawal id. | [object Object] | | `forceNocAchWithdrawalRequestCreate` | [components.ForceNocAchWithdrawalRequestCreate](../../models/components/forcenocachwithdrawalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.AchWithdrawalsForceNocAchWithdrawalResponse](../../models/operations/achwithdrawalsforcenocachwithdrawalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceRejectAchWithdrawal Forces rejection of an existing ACH withdrawal that is pending review. FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceRejectAchWithdrawal({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achWithdrawals/20230620500726", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230620500726"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceRejectAchWithdrawal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceRejectAchWithdrawal.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceRejectAchWithdrawal(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achWithdrawals/20230620500726", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230620500726"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceRejectAchWithdrawal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `achWithdrawalId` | *string* | :heavy_check_mark: | The achWithdrawal id. | [object Object] | | `forceRejectAchWithdrawalRequestCreate` | [components.ForceRejectAchWithdrawalRequestCreate](../../models/components/forcerejectachwithdrawalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.AchWithdrawalsForceRejectAchWithdrawalResponse](../../models/operations/achwithdrawalsforcerejectachwithdrawalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceReturnAchWithdrawal Forces a Nacha return on a completed ACH withdrawal. FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; import { NachaReturnCreateCode } from "@apexfintechsolutions/ascend-sdk/models/components"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceReturnAchWithdrawal({ nachaReturn: { code: NachaReturnCreateCode.R15, }, name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achWithdrawals/20230620500726", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230620500726"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceReturnAchWithdrawal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceReturnAchWithdrawal.js"; import { NachaReturnCreateCode } from "@apexfintechsolutions/ascend-sdk/models/components"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceReturnAchWithdrawal(apexascend, { nachaReturn: { code: NachaReturnCreateCode.R15, }, name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achWithdrawals/20230620500726", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230620500726"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceReturnAchWithdrawal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `achWithdrawalId` | *string* | :heavy_check_mark: | The achWithdrawal id. | [object Object] | | `forceReturnAchWithdrawalRequestCreate` | [components.ForceReturnAchWithdrawalRequestCreate](../../models/components/forcereturnachwithdrawalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.AchWithdrawalsForceReturnAchWithdrawalResponse](../../models/operations/achwithdrawalsforcereturnachwithdrawalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## getMicroDepositAmounts Gets micro deposit amounts for bank relationships with the `MICRO_DEPOSIT` verification method. FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.getMicroDepositAmounts("01H8FB90ZRRFWXB4XC2JPJ1D4Y", "651ef9de0dee00240813e60e"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationGetMicroDepositAmounts } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationGetMicroDepositAmounts.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationGetMicroDepositAmounts(apexascend, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "651ef9de0dee00240813e60e"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationGetMicroDepositAmounts failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `bankRelationshipId` | *string* | :heavy_check_mark: | The bankRelationship id. | [object Object] | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.BankRelationshipsGetMicroDepositAmountsResponse](../../models/operations/bankrelationshipsgetmicrodepositamountsresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceApproveIctDeposit Forces an approval on an existing ICT deposit pending review - FOR TESTING ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceApproveIctDeposit({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/ictDeposits/20240321000472", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20240321000472"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceApproveIctDeposit } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceApproveIctDeposit.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceApproveIctDeposit(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/ictDeposits/20240321000472", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20240321000472"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceApproveIctDeposit failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `ictDepositId` | *string* | :heavy_check_mark: | The ictDeposit id. | [object Object] | | `forceApproveIctDepositRequestCreate` | [components.ForceApproveIctDepositRequestCreate](../../models/components/forceapproveictdepositrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.IctDepositsForceApproveIctDepositResponse](../../models/operations/ictdepositsforceapproveictdepositresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceRejectIctDeposit Forces a rejection on an existing ICT deposit pending review - FOR TESTING ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceRejectIctDeposit({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/ictDeposits/20240321000472", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20240321000472"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceRejectIctDeposit } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceRejectIctDeposit.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceRejectIctDeposit(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/ictDeposits/20240321000472", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20240321000472"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceRejectIctDeposit failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `ictDepositId` | *string* | :heavy_check_mark: | The ictDeposit id. | [object Object] | | `forceRejectIctDepositRequestCreate` | [components.ForceRejectIctDepositRequestCreate](../../models/components/forcerejectictdepositrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.IctDepositsForceRejectIctDepositResponse](../../models/operations/ictdepositsforcerejectictdepositresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceApproveIctWithdrawal Forces an approval on an existing ICT withdrawal pending review - FOR TESTING ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceApproveIctWithdrawal({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/ictWithdrawals/20240321000472", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20240321000472"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceApproveIctWithdrawal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceApproveIctWithdrawal.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceApproveIctWithdrawal(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/ictWithdrawals/20240321000472", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20240321000472"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceApproveIctWithdrawal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `ictWithdrawalId` | *string* | :heavy_check_mark: | The ictWithdrawal id. | [object Object] | | `forceApproveIctWithdrawalRequestCreate` | [components.ForceApproveIctWithdrawalRequestCreate](../../models/components/forceapproveictwithdrawalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.IctWithdrawalsForceApproveIctWithdrawalResponse](../../models/operations/ictwithdrawalsforceapproveictwithdrawalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceRejectIctWithdrawal Forces a rejection on an existing ICT withdrawal pending review - FOR TESTING ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceRejectIctWithdrawal({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/ictWithdrawals/20240321000472", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20240321000472"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceRejectIctWithdrawal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceRejectIctWithdrawal.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceRejectIctWithdrawal(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/ictWithdrawals/20240321000472", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20240321000472"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceRejectIctWithdrawal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `ictWithdrawalId` | *string* | :heavy_check_mark: | The ictWithdrawal id. | [object Object] | | `forceRejectIctWithdrawalRequestCreate` | [components.ForceRejectIctWithdrawalRequestCreate](../../models/components/forcerejectictwithdrawalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.IctWithdrawalsForceRejectIctWithdrawalResponse](../../models/operations/ictwithdrawalsforcerejectictwithdrawalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceApproveWireWithdrawal Forces an approval on an existing wire withdrawal pending review - FOR TESTING ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceApproveWireWithdrawal({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/wireWithdrawals/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceApproveWireWithdrawal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceApproveWireWithdrawal.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceApproveWireWithdrawal(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/wireWithdrawals/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceApproveWireWithdrawal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `wireWithdrawalId` | *string* | :heavy_check_mark: | The wireWithdrawal id. | [object Object] | | `forceApproveWireWithdrawalRequestCreate` | [components.ForceApproveWireWithdrawalRequestCreate](../../models/components/forceapprovewirewithdrawalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.WireWithdrawalsForceApproveWireWithdrawalResponse](../../models/operations/wirewithdrawalsforceapprovewirewithdrawalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceRejectWireWithdrawal Forces a rejection on an existing wire withdrawal pending review - FOR TESTING ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceRejectWireWithdrawal({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/wireWithdrawals/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceRejectWireWithdrawal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceRejectWireWithdrawal.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceRejectWireWithdrawal(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/wireWithdrawals/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceRejectWireWithdrawal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `wireWithdrawalId` | *string* | :heavy_check_mark: | The wireWithdrawal id. | [object Object] | | `forceRejectWireWithdrawalRequestCreate` | [components.ForceRejectWireWithdrawalRequestCreate](../../models/components/forcerejectwirewithdrawalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.WireWithdrawalsForceRejectWireWithdrawalResponse](../../models/operations/wirewithdrawalsforcerejectwirewithdrawalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## simulateWireDeposit Simulates the process of creating a wire deposit - FOR TESTING ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.simulateWireDeposit({ amount: {}, parent: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationSimulateWireDeposit } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationSimulateWireDeposit.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationSimulateWireDeposit(apexascend, { amount: {}, parent: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationSimulateWireDeposit failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `simulateWireDepositRequestCreate` | [components.SimulateWireDepositRequestCreate](../../models/components/simulatewiredepositrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.WireDepositsSimulateWireDepositResponse](../../models/operations/wiredepositssimulatewiredepositresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceApproveWireDeposit Simulates the process of approving a wire deposit - FOR TESTING ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceApproveWireDeposit({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/wireDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceApproveWireDeposit } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceApproveWireDeposit.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceApproveWireDeposit(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/wireDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceApproveWireDeposit failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `wireDepositId` | *string* | :heavy_check_mark: | The wireDeposit id. | [object Object] | | `forceApproveWireDepositRequestCreate` | [components.ForceApproveWireDepositRequestCreate](../../models/components/forceapprovewiredepositrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.WireDepositsForceApproveWireDepositResponse](../../models/operations/wiredepositsforceapprovewiredepositresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceRejectWireDeposit Forces a rejection on an existing wire deposit pending review - FOR TESTING ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceRejectWireDeposit({ name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/wireDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceRejectWireDeposit } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceRejectWireDeposit.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceRejectWireDeposit(apexascend, { name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/wireDeposits/20230817000319", }, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceRejectWireDeposit failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] | | `wireDepositId` | *string* | :heavy_check_mark: | The wireDeposit id. | [object Object] | | `forceRejectWireDepositRequestCreate` | [components.ForceRejectWireDepositRequestCreate](../../models/components/forcerejectwiredepositrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.WireDepositsForceRejectWireDepositResponse](../../models/operations/wiredepositsforcerejectwiredepositresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceApproveCashJournal Forces approval of an existing cash journal that is pending review FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceApproveCashJournal({ name: "cashJournals/20230817000319", }, "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceApproveCashJournal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceApproveCashJournal.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceApproveCashJournal(apexascend, { name: "cashJournals/20230817000319", }, "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceApproveCashJournal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `cashJournalId` | *string* | :heavy_check_mark: | The cashJournal id. | [object Object] | | `forceApproveCashJournalRequestCreate` | [components.ForceApproveCashJournalRequestCreate](../../models/components/forceapprovecashjournalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.CashJournalsForceApproveCashJournalResponse](../../models/operations/cashjournalsforceapprovecashjournalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceRejectCashJournal Forces rejection of an existing cash journal that is pending review FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceRejectCashJournal({ name: "cashJournals/20230817000319", }, "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceRejectCashJournal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceRejectCashJournal.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceRejectCashJournal(apexascend, { name: "cashJournals/20230817000319", }, "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceRejectCashJournal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `cashJournalId` | *string* | :heavy_check_mark: | The cashJournal id. | [object Object] | | `forceRejectCashJournalRequestCreate` | [components.ForceRejectCashJournalRequestCreate](../../models/components/forcerejectcashjournalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.CashJournalsForceRejectCashJournalResponse](../../models/operations/cashjournalsforcerejectcashjournalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceApprovePositionJournal Forces approval of an existing position journal that is pending review FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceApprovePositionJournal({ name: "positionJournals/20230817000319", }, "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceApprovePositionJournal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceApprovePositionJournal.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceApprovePositionJournal(apexascend, { name: "positionJournals/20230817000319", }, "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceApprovePositionJournal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `positionJournalId` | *string* | :heavy_check_mark: | The positionJournal id. | [object Object] | | `forceApprovePositionJournalRequestCreate` | [components.ForceApprovePositionJournalRequestCreate](../../models/components/forceapprovepositionjournalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.PositionJournalsForceApprovePositionJournalResponse](../../models/operations/positionjournalsforceapprovepositionjournalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | ## forceRejectPositionJournal Forces rejection of an existing position journal that is pending review FOR TESTING ONLY! ### Example Usage ```typescript import { Apexascend } from "@apexfintechsolutions/ascend-sdk"; const apexascend = new Apexascend({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const result = await apexascend.testSimulation.forceRejectPositionJournal({ name: "positionJournals/20230817000319", }, "20230817000319"); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js"; import { testSimulationForceRejectPositionJournal } from "@apexfintechsolutions/ascend-sdk/funcs/testSimulationForceRejectPositionJournal.js"; // Use `ApexascendCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apexascend = new ApexascendCore({ security: { apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789", serviceAccountCreds: { privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}", name: "FinFirm", organization: "correspondents/00000000-0000-0000-0000-000000000000", type: "serviceAccount", }, }, }); async function run() { const res = await testSimulationForceRejectPositionJournal(apexascend, { name: "positionJournals/20230817000319", }, "20230817000319"); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("testSimulationForceRejectPositionJournal failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `positionJournalId` | *string* | :heavy_check_mark: | The positionJournal id. | [object Object] | | `forceRejectPositionJournalRequestCreate` | [components.ForceRejectPositionJournalRequestCreate](../../models/components/forcerejectpositionjournalrequestcreate.md) | :heavy_check_mark: | N/A | | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response **Promise\<[operations.PositionJournalsForceRejectPositionJournalResponse](../../models/operations/positionjournalsforcerejectpositionjournalresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.Status | 400, 403, 404 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* |