Variable OrganizationPaymentInstrumentApiConst

Type Declaration

• Readonly/v1/organization/{organizationId}/instrument: {
      get: {
          description: "Retrieve the list of payment instruments associated with the CFX organization.";
          params: TObject<{ organizationId: TString }>;
          querystring: TObject<
              {
                  type: TOptional<
                      TUnion<
                          [
                              TLiteral<"WALLET">,
                              TLiteral<"MX_CLABE">,
                              TLiteral<"US_ACH">,
                              TLiteral<"AF_BANK">,
                              TLiteral<"AF_MOMO">,
                              TLiteral<"SWIFT_WIRE">,
                              TLiteral<"US_WIRE">,
                              TLiteral<"US_INSTANT">,
                          ],
                      >,
                  >;
              },
          >;
          response: {
              "200": TObject<
                  {
                      results: TArray<
                          TUnion<
                              [
                                  TIntersect<[(...), (...)]>,
                                  TIntersect<[(...), (...)]>,
                                  TIntersect<[(...), (...)]>,
                                  TIntersect<[(...), (...)]>,
                                  TIntersect<[(...), (...)]>,
                              ],
                          >,
                      >;
                  },
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Search Payment Instruments";
          tags: readonly ["Organization", "Instruments"];
      };
      post: {
          body: TUnion<
              [
                  TIntersect<
                      [
                          TObject<
                              { chain: TUnion<[(...), (...), (...)]>; type: TLiteral<"WALLET"> },
                          >,
                          TObject<{ address: TString }>,
                      ],
                  >,
                  TIntersect<
                      [
                          TObject<{ accountHolderName: TOptional<TString> }>,
                          TObject<
                              {
                                  accountName: TString;
                                  accountNumber: TString;
                                  accountType: TOptional<TUnion<(...)>>;
                                  referenceId: TOptional<TString>;
                                  routingNumber: TString;
                                  type: TLiteral<"US_ACH">;
                              },
                          >,
                      ],
                  >,
                  TIntersect<
                      [
                          TObject<{ accountHolderName: TOptional<TString> }>,
                          TObject<
                              {
                                  accountNumber: TString;
                                  referenceId: TOptional<TString>;
                                  routingNumber: TString;
                                  type: TLiteral<"US_INSTANT">;
                              },
                          >,
                      ],
                  >,
                  TObject<
                      {
                          accountNumber: TString;
                          beneficiary: TIntersect<
                              [
                                  TObject<{ address: ...; email: ...; phone: ...; reference: ... }>,
                                  TUnion<[(...), (...)]>,
                              ],
                          >;
                          financialInstitution: TObject<
                              {
                                  address: TObject<
                                      { city: ...; line1: ...; postalCode: ...; state: ... },
                                  >;
                                  name: TString;
                              },
                          >;
                          referenceId: TOptional<TString>;
                          routingNumber: TString;
                          type: TLiteral<"US_WIRE">;
                      },
                  >,
                  TObject<
                      {
                          accountNumber: TOptional<TString>;
                          beneficiary: TIntersect<
                              [
                                  TObject<{ address: ...; email: ...; phone: ...; reference: ... }>,
                                  TUnion<[(...), (...)]>,
                              ],
                          >;
                          iban: TOptional<TString>;
                          intermediaryRoutingNumber: TOptional<TString>;
                          localAccountNumber: TOptional<TString>;
                          localBankCode: TOptional<TString>;
                          referenceId: TOptional<TString>;
                          routingNumber: TOptional<TString>;
                          type: TLiteral<"SWIFT_WIRE">;
                      },
                  >,
              ],
          >;
          description: "Create a payment instrument that will be associated with a CFX organization.";
          params: TObject<{ organizationId: TString }>;
          response: {
              "201": TUnion<
                  [
                      TIntersect<
                          [
                              TObject<
                                  {
                                      id: TString;
                                      providerId: TString;
                                      referenceId: TOptional<(...)>;
                                      status: TUnsafe<(...)>;
                                  },
                              >,
                              TObject<
                                  {
                                      address: TString;
                                      chain: TUnion<(...)>;
                                      staticMemo: TOptional<(...)>;
                                      type: TLiteral<(...)>;
                                  },
                              >,
                          ],
                      >,
                      TIntersect<
                          [
                              TObject<
                                  {
                                      id: TString;
                                      providerId: TString;
                                      referenceId: TOptional<(...)>;
                                      status: TUnsafe<(...)>;
                                  },
                              >,
                              TObject<
                                  {
                                      accountNumber: TOptional<(...)>;
                                      beneficiary: TIntersect<(...)>;
                                      financialInstitution: TObject<(...)>;
                                      iban: TOptional<(...)>;
                                      intermediaryFinancialInstitution: TOptional<(...)>;
                                      intermediaryRoutingNumber: TOptional<(...)>;
                                      localAccountNumber: TOptional<(...)>;
                                      localBankCode: TOptional<(...)>;
                                      routingNumber: TOptional<(...)>;
                                      type: TLiteral<(...)>;
                                  },
                              >,
                          ],
                      >,
                      TIntersect<
                          [
                              TObject<
                                  {
                                      id: TString;
                                      providerId: TString;
                                      referenceId: TOptional<(...)>;
                                      status: TUnsafe<(...)>;
                                  },
                              >,
                              TObject<
                                  {
                                      accountHolderName: TString;
                                      accountNumber: TString;
                                      routingNumber: TString;
                                      type: TLiteral<(...)>;
                                  },
                              >,
                          ],
                      >,
                      TIntersect<
                          [
                              TObject<
                                  {
                                      id: TString;
                                      providerId: TString;
                                      referenceId: TOptional<(...)>;
                                      status: TUnsafe<(...)>;
                                  },
                              >,
                              TObject<
                                  {
                                      accountHolderName: TString;
                                      accountName: TString;
                                      accountNumber: TString;
                                      accountType: TOptional<(...)>;
                                      routingNumber: TString;
                                      type: TLiteral<(...)>;
                                  },
                              >,
                          ],
                      >,
                      TIntersect<
                          [
                              TObject<
                                  {
                                      id: TString;
                                      providerId: TString;
                                      referenceId: TOptional<(...)>;
                                      status: TUnsafe<(...)>;
                                  },
                              >,
                              TObject<
                                  {
                                      accountNumber: TString;
                                      beneficiary: TIntersect<(...)>;
                                      financialInstitution: TObject<(...)>;
                                      routingNumber: TString;
                                      type: TLiteral<(...)>;
                                  },
                              >,
                          ],
                      >,
                  ],
              >;
              "400": TUnion<
                  [
                      TObject<{ code: TLiteral<"INVALID_ENTITY">; message: TString }>,
                      TIntersect<
                          [
                              TObject<{ code: TLiteral<(...)>; message: TString }>,
                              TObject<{ existing: TNumber; limit: TNumber }>,
                          ],
                      >,
                      TObject<{ code: TLiteral<"INVALID_EMAIL">; message: TString }>,
                      TObject<{ code: TLiteral<"INVALID_PHONE">; message: TString }>,
                  ],
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Create Payment Instrument";
          tags: readonly ["Organization", "Instruments"];
      };
  }

• Readonly/v1/organization/{organizationId}/instrument/{instrumentId}: {
      delete: {
          description: "Delete a payment instrument.";
          params: TObject<{ instrumentId: TString; organizationId: TString }>;
          response: { "200": TObject<{ message: TString }> };
          summary: "Delete Payment Instrument";
          tags: readonly ["Organization", "Instruments"];
      };
      get: {
          description: "Retrieve details for a specific payment instrument.";
          params: TObject<{ instrumentId: TString; organizationId: TString }>;
          response: {
              "200": TUnion<
                  [
                      TIntersect<
                          [
                              TObject<
                                  {
                                      id: TString;
                                      providerId: TString;
                                      referenceId: TOptional<(...)>;
                                      status: TUnsafe<(...)>;
                                  },
                              >,
                              TObject<
                                  {
                                      address: TString;
                                      chain: TUnion<(...)>;
                                      staticMemo: TOptional<(...)>;
                                      type: TLiteral<(...)>;
                                  },
                              >,
                          ],
                      >,
                      TIntersect<
                          [
                              TObject<
                                  {
                                      id: TString;
                                      providerId: TString;
                                      referenceId: TOptional<(...)>;
                                      status: TUnsafe<(...)>;
                                  },
                              >,
                              TObject<
                                  {
                                      accountNumber: TOptional<(...)>;
                                      beneficiary: TIntersect<(...)>;
                                      financialInstitution: TObject<(...)>;
                                      iban: TOptional<(...)>;
                                      intermediaryFinancialInstitution: TOptional<(...)>;
                                      intermediaryRoutingNumber: TOptional<(...)>;
                                      localAccountNumber: TOptional<(...)>;
                                      localBankCode: TOptional<(...)>;
                                      routingNumber: TOptional<(...)>;
                                      type: TLiteral<(...)>;
                                  },
                              >,
                          ],
                      >,
                      TIntersect<
                          [
                              TObject<
                                  {
                                      id: TString;
                                      providerId: TString;
                                      referenceId: TOptional<(...)>;
                                      status: TUnsafe<(...)>;
                                  },
                              >,
                              TObject<
                                  {
                                      accountHolderName: TString;
                                      accountNumber: TString;
                                      routingNumber: TString;
                                      type: TLiteral<(...)>;
                                  },
                              >,
                          ],
                      >,
                      TIntersect<
                          [
                              TObject<
                                  {
                                      id: TString;
                                      providerId: TString;
                                      referenceId: TOptional<(...)>;
                                      status: TUnsafe<(...)>;
                                  },
                              >,
                              TObject<
                                  {
                                      accountHolderName: TString;
                                      accountName: TString;
                                      accountNumber: TString;
                                      accountType: TOptional<(...)>;
                                      routingNumber: TString;
                                      type: TLiteral<(...)>;
                                  },
                              >,
                          ],
                      >,
                      TIntersect<
                          [
                              TObject<
                                  {
                                      id: TString;
                                      providerId: TString;
                                      referenceId: TOptional<(...)>;
                                      status: TUnsafe<(...)>;
                                  },
                              >,
                              TObject<
                                  {
                                      accountNumber: TString;
                                      beneficiary: TIntersect<(...)>;
                                      financialInstitution: TObject<(...)>;
                                      routingNumber: TString;
                                      type: TLiteral<(...)>;
                                  },
                              >,
                          ],
                      >,
                  ],
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Get Payment Instrument";
          tags: readonly ["Organization", "Instruments"];
      };
  }