Variable virtualAccountApiConst

Type Declaration

• Readonly/v1/virtual-accounts: {
      get: {
          querystring: TObject<
              {
                  ids: TOptional<TString>;
                  ledgerAccountIds: TOptional<TString>;
                  page: TOptional<TInteger>;
                  pageSize: TOptional<TInteger>;
              },
          >;
          response: {
              "200": TObject<
                  {
                      hasNext: TBoolean;
                      items: TArray<
                          TObject<
                              {
                                  accountNumber: TString;
                                  achDepositInstructions: TObject<
                                      {
                                          accountNumber: ...;
                                          bankAddress: ...;
                                          bankName: ...;
                                          beneficiaryName: ...;
                                          currency: ...;
                                          currencyCountryCode: ...;
                                          routingNumber: ...;
                                      },
                                  >;
                                  createdAt: TString;
                                  entityId: TString;
                                  id: TString;
                                  ledgerAccountId: TString;
                                  name: TUnsafe<(...) | (...)>;
                                  referenceId: TUnsafe<(...) | (...)>;
                                  routingNumber: TString;
                                  rtpDepositInstructions: TObject<
                                      {
                                          accountNumber: ...;
                                          bankAddress: ...;
                                          bankName: ...;
                                          beneficiaryName: ...;
                                          currency: ...;
                                          currencyCountryCode: ...;
                                          routingNumber: ...;
                                      },
                                  >;
                                  status: TUnsafe<(...) | (...)>;
                                  type: TUnsafe<(...) | (...)>;
                                  updatedAt: TString;
                                  wireDepositInstructions: TObject<
                                      {
                                          accountNumber: ...;
                                          bankAddress: ...;
                                          bankName: ...;
                                          beneficiaryAddress: ...;
                                          beneficiaryName: ...;
                                          currency: ...;
                                          currencyCountryCode: ...;
                                          routingNumber: ...;
                                      },
                                  >;
                              },
                          >,
                      >;
                      page: TInteger;
                      pageSize: TInteger;
                  },
              >;
          };
          summary: "Search virtual accounts";
          tags: readonly ["Virtual Account"];
      };
  }

• Readonly/v1/virtual-accounts/{id}: {
      delete: {
          params: TObject<{ id: TString }>;
          response: {
              "204": TNull;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Delete a virtual account";
          tags: readonly ["Virtual Account"];
      };
      get: {
          params: TObject<{ id: TString }>;
          response: {
              "200": TObject<
                  {
                      accountNumber: TString;
                      achDepositInstructions: TObject<
                          {
                              accountNumber: TString;
                              bankAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      postalCode: TString;
                                      regionCode: TString;
                                  },
                              >;
                              bankName: TString;
                              beneficiaryName: TString;
                              currency: TString;
                              currencyCountryCode: TString;
                              routingNumber: TString;
                          },
                      >;
                      createdAt: TString;
                      entityId: TString;
                      id: TString;
                      ledgerAccountId: TString;
                      name: TUnsafe<string | null>;
                      referenceId: TUnsafe<string | null>;
                      routingNumber: TString;
                      rtpDepositInstructions: TObject<
                          {
                              accountNumber: TString;
                              bankAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      postalCode: TString;
                                      regionCode: TString;
                                  },
                              >;
                              bankName: TString;
                              beneficiaryName: TString;
                              currency: TString;
                              currencyCountryCode: TString;
                              routingNumber: TString;
                          },
                      >;
                      status: TUnsafe<"ACTIVE" | "PENDING">;
                      type: TUnsafe<"US_DEPOSIT" | "US_DDA">;
                      updatedAt: TString;
                      wireDepositInstructions: TObject<
                          {
                              accountNumber: TString;
                              bankAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      postalCode: TString;
                                      regionCode: TString;
                                  },
                              >;
                              bankName: TString;
                              beneficiaryAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      line2: TOptional<(...)>;
                                      postalCode: TString;
                                      regionCode: TOptional<(...)>;
                                  },
                              >;
                              beneficiaryName: TString;
                              currency: TString;
                              currencyCountryCode: TString;
                              routingNumber: TString;
                          },
                      >;
                  },
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Get a virtual account";
          tags: readonly ["Virtual Account"];
      };
      patch: {
          body: TObject<
              { name: TOptional<TString>; referenceId: TOptional<TString> },
          >;
          params: TObject<{ id: TString }>;
          response: {
              "200": TObject<
                  {
                      accountNumber: TString;
                      achDepositInstructions: TObject<
                          {
                              accountNumber: TString;
                              bankAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      postalCode: TString;
                                      regionCode: TString;
                                  },
                              >;
                              bankName: TString;
                              beneficiaryName: TString;
                              currency: TString;
                              currencyCountryCode: TString;
                              routingNumber: TString;
                          },
                      >;
                      createdAt: TString;
                      entityId: TString;
                      id: TString;
                      ledgerAccountId: TString;
                      name: TUnsafe<string | null>;
                      referenceId: TUnsafe<string | null>;
                      routingNumber: TString;
                      rtpDepositInstructions: TObject<
                          {
                              accountNumber: TString;
                              bankAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      postalCode: TString;
                                      regionCode: TString;
                                  },
                              >;
                              bankName: TString;
                              beneficiaryName: TString;
                              currency: TString;
                              currencyCountryCode: TString;
                              routingNumber: TString;
                          },
                      >;
                      status: TUnsafe<"ACTIVE" | "PENDING">;
                      type: TUnsafe<"US_DEPOSIT" | "US_DDA">;
                      updatedAt: TString;
                      wireDepositInstructions: TObject<
                          {
                              accountNumber: TString;
                              bankAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      postalCode: TString;
                                      regionCode: TString;
                                  },
                              >;
                              bankName: TString;
                              beneficiaryAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      line2: TOptional<(...)>;
                                      postalCode: TString;
                                      regionCode: TOptional<(...)>;
                                  },
                              >;
                              beneficiaryName: TString;
                              currency: TString;
                              currencyCountryCode: TString;
                              routingNumber: TString;
                          },
                      >;
                  },
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Update a virtual account";
          tags: readonly ["Virtual Account"];
      };
  }

• Readonly/v1/virtual-accounts/us-deposit: {
      post: {
          body: TObject<
              {
                  ledgerAccountId: TString;
                  name: TString;
                  referenceId: TOptional<TString>;
              },
          >;
          response: {
              "200": TObject<
                  {
                      accountNumber: TString;
                      achDepositInstructions: TObject<
                          {
                              accountNumber: TString;
                              bankAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      postalCode: TString;
                                      regionCode: TString;
                                  },
                              >;
                              bankName: TString;
                              beneficiaryName: TString;
                              currency: TString;
                              currencyCountryCode: TString;
                              routingNumber: TString;
                          },
                      >;
                      createdAt: TString;
                      entityId: TString;
                      id: TString;
                      ledgerAccountId: TString;
                      name: TUnsafe<string | null>;
                      referenceId: TUnsafe<string | null>;
                      routingNumber: TString;
                      rtpDepositInstructions: TObject<
                          {
                              accountNumber: TString;
                              bankAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      postalCode: TString;
                                      regionCode: TString;
                                  },
                              >;
                              bankName: TString;
                              beneficiaryName: TString;
                              currency: TString;
                              currencyCountryCode: TString;
                              routingNumber: TString;
                          },
                      >;
                      status: TUnsafe<"ACTIVE" | "PENDING">;
                      type: TUnsafe<"US_DEPOSIT" | "US_DDA">;
                      updatedAt: TString;
                      wireDepositInstructions: TObject<
                          {
                              accountNumber: TString;
                              bankAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      postalCode: TString;
                                      regionCode: TString;
                                  },
                              >;
                              bankName: TString;
                              beneficiaryAddress: TObject<
                                  {
                                      city: TString;
                                      countryCode: TString;
                                      line1: TString;
                                      line2: TOptional<(...)>;
                                      postalCode: TString;
                                      regionCode: TOptional<(...)>;
                                  },
                              >;
                              beneficiaryName: TString;
                              currency: TString;
                              currencyCountryCode: TString;
                              routingNumber: TString;
                          },
                      >;
                  },
              >;
              "400": TUnion<
                  [
                      TObject<
                          {
                              code: TLiteral<"INVALID_REQUEST">;
                              errors: TOptional<TArray<TObject<(...)>>>;
                              message: TString;
                          },
                      >,
                      TObject<{ code: TLiteral<"INVALID_ENTITY">; message: TString }>,
                      TObject<{ code: TLiteral<"ENTITY_NOT_FOUND">; message: TString }>,
                      TObject<{ code: TLiteral<"DUPLICATE">; message: TString }>,
                  ],
              >;
          };
          summary: "Create a US deposit virtual account";
          tags: readonly ["Virtual Account"];
      };
  }