Variable usBankAchDepositRequestApiConst

Type Declaration

• Readonly/v1/deposit/us-bank-ach: {
      post: {
          body: TUnion<
              [
                  TIntersect<
                      [
                          TObject<{ identityId: TString }>,
                          TObject<
                              {
                                  amount: TObject<{ amount: ...; currency: ... }>;
                                  reference: TString;
                                  sourcePaymentInstrumentId: TString;
                                  wallet: TObject<{ address: ...; blockchain: ... }>;
                              },
                          >,
                      ],
                  >,
                  TIntersect<
                      [
                          TObject<{ organizationId: TString }>,
                          TObject<
                              {
                                  amount: TObject<{ amount: ...; currency: ... }>;
                                  reference: TString;
                                  sourcePaymentInstrumentId: TString;
                                  wallet: TObject<{ address: ...; blockchain: ... }>;
                              },
                          >,
                      ],
                  >,
              ],
          >;
          description: "Creates a request to mint MOVEUSD by debiting a US bank account via ACH.\n\nSource bank accounts need to be registered as Payment Instruments which are associated with an Identity or Organization. ACH Deposit Requests refer to this Payment Instrument in the `sourcePaymentInstrumentId` field. Registered deposit requests will result in an ACH pull from the nominated bank account. After the debit is processed and reconciled the funds will be minted to the wallet specified in the request.";
          response: {
              "201": TObject<
                  {
                      createdAt: TString;
                      id: TString;
                      status: TUnsafe<
                          "CREATED"
                          | "CANCELLED"
                          | "PROCESSING"
                          | "SUCCEEDED"
                          | "FAILED",
                      >;
                  },
              >;
              "400": TObject<
                  {
                      code: TString;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
              default: TObject<
                  {
                      code: TString;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
          };
          summary: "Create US Bank ACH Deposit Request";
          tags: readonly ["US Bank ACH"];
      };
  }

• Readonly/v1/deposit/us-bank-ach/{id}: {
      get: {
          description: "Retrieve a previously submitted US Bank ACH deposit request.";
          params: TObject<{ id: TString }>;
          response: {
              "200": TUnion<
                  [
                      TIntersect<
                          [
                              TObject<{ identityId: TString }>,
                              TIntersect<[TObject<(...)>, TObject<(...)>]>,
                          ],
                      >,
                      TIntersect<
                          [
                              TObject<{ organizationId: TString }>,
                              TIntersect<[TObject<(...)>, TObject<(...)>]>,
                          ],
                      >,
                  ],
              >;
              "400": TObject<
                  {
                      code: TString;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
              "404": TObject<
                  {
                      code: TLiteral<"notFound">;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
              default: TObject<
                  {
                      code: TString;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
          };
          summary: "Get US Bank ACH Deposit Request";
          tags: readonly ["US Bank ACH"];
      };
  }