Class SwiftBicDirService

Index

Constructors

Methods

Constructors

constructor

new SwiftBicDirService(
    args: {
        swiftCodesValidationClient: Pick<SwiftCodesValidationClient, "getBic">;
        valkeyClient: ValkeyClient | null;
    },
): SwiftBicDirService
Parameters
- args: {
  swiftCodesValidationClient: Pick<SwiftCodesValidationClient, "getBic">;
  valkeyClient: ValkeyClient | null;
  }
Returns SwiftBicDirService
- Defined in packages/payment-instrument-services/src/SwiftBicDirService.ts:23

Methods

getBic

getBic(
    __namedParameters: { bic: string },
): Promise<
    {
        ok: true;
        value: | {
            address?: string;
            bank?: { code?: string; country_id?: string; id?: string; name?: string };
            branch_code?: string;
            branch_name?: string;
            city?: { country_id?: string; id?: string; name?: string };
            country?: { id?: string; name?: string };
            id?: string;
            postcode?: string;
        }
        | null;
    },
>
Look up SWIFT/BIC bank info, cached. Returns null when the code is unknown (cached as a negative result). Non-functional errors (network, the upstream API rejecting the code) propagate as thrown errors.
Parameters
- __namedParameters: { bic: string }
Returns Promise<
    {
        ok: true;
        value: | {
            address?: string;
            bank?: { code?: string; country_id?: string; id?: string; name?: string };
            branch_code?: string;
            branch_name?: string;
            city?: { country_id?: string; id?: string; name?: string };
            country?: { id?: string; name?: string };
            id?: string;
            postcode?: string;
        }
        | null;
    },
>
- Defined in packages/payment-instrument-services/src/SwiftBicDirService.ts:41