Variable identityDepositMemoApiConst

Type Declaration

• Readonly/v1/identity/{identityId}/ledger-accounts/{accountId}/deposit-memos: {
      get: {
          params: TObject<{ accountId: TString; identityId: TString }>;
          querystring: TObject<
              {
                  createdAfter: TOptional<TString>;
                  createdBefore: TOptional<TString>;
                  frequencies: TOptional<TString>;
                  methods: TOptional<TString>;
                  orderBy: TOptional<TString>;
                  page: TOptional<TInteger>;
                  pageSize: TOptional<TInteger>;
                  sourceCurrencies: TOptional<TString>;
                  statuses: TOptional<TString>;
                  updatedAfter: TOptional<TString>;
                  updatedBefore: TOptional<TString>;
              },
          >;
          response: {
              "200": TObject<
                  {
                      hasNext: TBoolean;
                      items: TArray<
                          TIntersect<
                              [
                                  TObject<
                                      {
                                          consumedAt: ...;
                                          createdAt: ...;
                                          frequency: ...;
                                          memo: ...;
                                          name: ...;
                                          sourceCurrency: ...;
                                          status: ...;
                                          updatedAt: ...;
                                      },
                                  >,
                                  TUnion<[(...), (...)]>,
                              ],
                          >,
                      >;
                  },
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Search for deposit memos for a ledger account of an identity";
          tags: readonly ["Identity", "Ledger Account", "Deposit Memo"];
      };
      post: {
          body: TIntersect<
              [
                  TObject<
                      {
                          method: TUnion<[TUnsafe<"US_WIRE">, TUnsafe<"SWIFT_WIRE">]>;
                          name: TOptional<TString>;
                          sourceCurrency: TUnion<
                              [
                                  TLiteral<"USD">,
                                  TLiteral<"AUD">,
                                  TLiteral<"HKD">,
                                  TLiteral<"JPY">,
                                  TLiteral<"MXN">,
                                  TLiteral<"NZD">,
                                  TLiteral<"SGD">,
                                  TLiteral<"SEK">,
                              ],
                          >;
                      },
                  >,
                  TObject<
                      {
                          bankPartner: TOptional<TEnum<["metcap", "greendot", "dart"]>>;
                          frequency: TOptional<TUnsafe<"ONE_TIME" | "RECURRING">>;
                      },
                  >,
              ],
          >;
          description: "Include this memo in your deposit and the funds will be sent to the given ledger account.\n\nOnly one recurring memo can be created for the same method and currency type.\n\n**Important:** When using the instructions, ensure all fields match the instruction values exactly so the funds are routed correctly. Do no add any other information but what is provided into memo/reference/message field when making a deposit.";
          params: TObject<{ accountId: TString; identityId: TString }>;
          response: {
              "200": TIntersect<
                  [
                      TObject<
                          {
                              consumedAt: TOptional<TString>;
                              createdAt: TString;
                              frequency: TUnsafe<"ONE_TIME" | "RECURRING">;
                              memo: TString;
                              name: TOptional<TString>;
                              sourceCurrency: TUnion<
                                  [
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                  ],
                              >;
                              status: TUnsafe<"ACTIVE" | "DISABLED" | "CONSUMED">;
                              updatedAt: TString;
                          },
                      >,
                      TUnion<
                          [
                              TObject<{ instructions: TObject<(...)>; method: TUnsafe<(...)> }>,
                              TObject<{ instructions: TUnion<(...)>; method: TUnsafe<(...)> }>,
                          ],
                      >,
                  ],
              >;
              "400": TUnion<
                  [
                      TObject<{ code: TLiteral<"INVALID_METHOD">; message: TString }>,
                      TObject<{ code: TLiteral<"INVALID_IDENTITY">; message: TString }>,
                      TObject<{ code: TLiteral<"DUPLICATE">; message: TString }>,
                      TObject<{ code: TLiteral<"INVALID_CURRENCY">; message: TString }>,
                  ],
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Create a deposit memo for an identity's ledger account";
          tags: readonly ["Identity", "Ledger Account", "Deposit Memo"];
      };
  }

• Readonly/v1/identity/{identityId}/ledger-accounts/{accountId}/deposit-memos/{memo}: {
      get: {
          params: TObject<
              { accountId: TString; identityId: TString; memo: TString },
          >;
          response: {
              "200": TIntersect<
                  [
                      TObject<
                          {
                              consumedAt: TOptional<TString>;
                              createdAt: TString;
                              frequency: TUnsafe<"ONE_TIME" | "RECURRING">;
                              memo: TString;
                              name: TOptional<TString>;
                              sourceCurrency: TUnion<
                                  [
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                      TLiteral<(...)>,
                                  ],
                              >;
                              status: TUnsafe<"ACTIVE" | "DISABLED" | "CONSUMED">;
                              updatedAt: TString;
                          },
                      >,
                      TUnion<
                          [
                              TObject<{ instructions: TObject<(...)>; method: TUnsafe<(...)> }>,
                              TObject<{ instructions: TUnion<(...)>; method: TUnsafe<(...)> }>,
                          ],
                      >,
                  ],
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Get a deposit memo details for an identity's ledger account";
          tags: readonly ["Identity", "Ledger Account", "Deposit Memo"];
      };
  }