@nokinc-flur/sdk 2.3.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +183 -305
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +68 -188
- package/dist/index.d.ts +68 -188
- package/dist/index.js +181 -295
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -4104,6 +4104,30 @@ declare function verifyConsumerSettlementReceiptQR(value: string, issuerPublicKe
|
|
|
4104
4104
|
declare function decodeConsumerSettlementReceiptQR(value: string): ConsumerSettlement;
|
|
4105
4105
|
declare function decodeConsumerSettlementReceiptQR(value: string, issuerPublicKeySpkiB64: string): ConsumerSettlement;
|
|
4106
4106
|
|
|
4107
|
+
/**
|
|
4108
|
+
* Offline verification of the unified Offline Authorization Certificate (OAC).
|
|
4109
|
+
*
|
|
4110
|
+
* The OAC is issuer-signed and folds identity (phoneE164, displayName, bound
|
|
4111
|
+
* device key) into the same credential that carries offline spend authority.
|
|
4112
|
+
* This lets two users who meet for the first time recognise and pay each
|
|
4113
|
+
* other WITHOUT a network round-trip: the verifier checks the issuer
|
|
4114
|
+
* signature against a *pinned* trusted issuer key (a Trust Bundle refreshed
|
|
4115
|
+
* whenever the device is online), never the key embedded in the credential.
|
|
4116
|
+
*
|
|
4117
|
+
* Trust model:
|
|
4118
|
+
* - Provisional offline authorization, authoritative online settlement.
|
|
4119
|
+
* A successful offline verify proves the credential was issued by Flur
|
|
4120
|
+
* and is within its validity window; the backend still re-checks
|
|
4121
|
+
* revocation, balance, and caps at settlement. Short OAC TTL is the
|
|
4122
|
+
* revocation-propagation mechanism — a revoked user cannot refresh and
|
|
4123
|
+
* their OAC expires within the issuance TTL.
|
|
4124
|
+
*
|
|
4125
|
+
* Wire format mirrors `flur-backend/src/offline-consumer/service.ts`
|
|
4126
|
+
* (`oacSigningPayload`): the issuer signs `canonicalJSONBytes({ domain, ...oac })`
|
|
4127
|
+
* with its P-256 key. Adding fields to `ConsumerOAC` automatically includes
|
|
4128
|
+
* them in the signed bytes, so identity is covered without a new domain.
|
|
4129
|
+
*/
|
|
4130
|
+
|
|
4107
4131
|
/**
|
|
4108
4132
|
* Domain tag bound into the OAC issuer signature. MUST match
|
|
4109
4133
|
* `OAC_DOMAIN` in `flur-backend/src/offline-consumer/service.ts`.
|
|
@@ -4185,17 +4209,57 @@ declare function verifyOacOffline(signed: SignedConsumerOAC, trustedKeys: readon
|
|
|
4185
4209
|
declare const CONSUMER_OAC_QR_PREFIX: "FLUROAC1.";
|
|
4186
4210
|
/** True iff `value` looks like a presented OAC QR payload. */
|
|
4187
4211
|
declare function isConsumerOacQR(value: string): boolean;
|
|
4212
|
+
/**
|
|
4213
|
+
* Advisory "pay me" request a holder may attach to a presented OAC pay code:
|
|
4214
|
+
* an amount, a purpose/intent, and a free-text reference. This rides as an
|
|
4215
|
+
* UNSIGNED suffix on the QR (see {@link encodeConsumerOacQR}) — it is never
|
|
4216
|
+
* part of the issuer-signed credential and carries no authority. The payer's
|
|
4217
|
+
* app treats it purely as a prefill hint and always confirms the amount,
|
|
4218
|
+
* exactly as with a NIBSS dynamic QR.
|
|
4219
|
+
*/
|
|
4220
|
+
declare const OacPresentmentRequestSchema: z.ZodObject<{
|
|
4221
|
+
/** Requested amount in minor units (kobo). */
|
|
4222
|
+
amountMinor: z.ZodOptional<z.ZodNumber>;
|
|
4223
|
+
/** Purpose/intent code (mirrors the NIBSS intent vocabulary). */
|
|
4224
|
+
intent: z.ZodOptional<z.ZodString>;
|
|
4225
|
+
/** Free-text reference / note. */
|
|
4226
|
+
reference: z.ZodOptional<z.ZodString>;
|
|
4227
|
+
}, "strict", z.ZodTypeAny, {
|
|
4228
|
+
amountMinor?: number | undefined;
|
|
4229
|
+
reference?: string | undefined;
|
|
4230
|
+
intent?: string | undefined;
|
|
4231
|
+
}, {
|
|
4232
|
+
amountMinor?: number | undefined;
|
|
4233
|
+
reference?: string | undefined;
|
|
4234
|
+
intent?: string | undefined;
|
|
4235
|
+
}>;
|
|
4236
|
+
type OacPresentmentRequest = z.infer<typeof OacPresentmentRequestSchema>;
|
|
4188
4237
|
/**
|
|
4189
4238
|
* Encode a signed OAC as a scannable QR payload. The envelope is validated
|
|
4190
4239
|
* before encoding so a malformed credential can never be presented.
|
|
4240
|
+
*
|
|
4241
|
+
* An optional advisory {@link OacPresentmentRequest} is appended as a
|
|
4242
|
+
* dot-separated, base64url-encoded suffix:
|
|
4243
|
+
* `FLUROAC1.<base64url(signed)>.<base64url(request)>`
|
|
4244
|
+
* The signed segment is byte-identical with or without the suffix, so the
|
|
4245
|
+
* credential's verifiability is unaffected. An empty request adds no suffix.
|
|
4191
4246
|
*/
|
|
4192
|
-
declare function encodeConsumerOacQR(signed: SignedConsumerOAC): string;
|
|
4247
|
+
declare function encodeConsumerOacQR(signed: SignedConsumerOAC, request?: OacPresentmentRequest): string;
|
|
4193
4248
|
/**
|
|
4194
4249
|
* Decode (WITHOUT verifying) a presented OAC QR back into a signed envelope.
|
|
4195
|
-
*
|
|
4196
|
-
*
|
|
4250
|
+
* Any advisory request suffix is ignored here — use
|
|
4251
|
+
* {@link decodeConsumerOacRequest} to read it. The caller MUST pass the result
|
|
4252
|
+
* to `verifyOacOffline` against pinned keys before trusting any field —
|
|
4253
|
+
* decoding proves nothing about authenticity.
|
|
4197
4254
|
*/
|
|
4198
4255
|
declare function decodeUnverifiedConsumerOacQR(value: string): SignedConsumerOAC;
|
|
4256
|
+
/**
|
|
4257
|
+
* Read the advisory {@link OacPresentmentRequest} from a presented OAC QR, or
|
|
4258
|
+
* `null` if absent/malformed. This is purely a prefill hint and is NEVER
|
|
4259
|
+
* authoritative — a malformed suffix is treated as "no request" and never
|
|
4260
|
+
* throws, so a bad suffix can never block a verifiable credential.
|
|
4261
|
+
*/
|
|
4262
|
+
declare function decodeConsumerOacRequest(value: string): OacPresentmentRequest | null;
|
|
4199
4263
|
|
|
4200
4264
|
/**
|
|
4201
4265
|
* FLURA1 — single-SMS consumer-offline settle token.
|
|
@@ -5206,7 +5270,6 @@ declare const ARTIFACT_TYPES: {
|
|
|
5206
5270
|
readonly STATEMENT: "statement";
|
|
5207
5271
|
readonly PASS: "pass";
|
|
5208
5272
|
readonly IDENTITY: "identity";
|
|
5209
|
-
readonly PAY_CARD: "pay_card";
|
|
5210
5273
|
};
|
|
5211
5274
|
type ArtifactType = (typeof ARTIFACT_TYPES)[keyof typeof ARTIFACT_TYPES];
|
|
5212
5275
|
declare const OfflinePaymentAuthorizationArtifactSchema: z.ZodObject<{
|
|
@@ -5850,23 +5913,6 @@ declare const IdentityArtifactSchema: z.ZodObject<{
|
|
|
5850
5913
|
claimType: "phone_verified" | "email_verified" | "bvn_verified" | "kyc_tier" | "age_band";
|
|
5851
5914
|
claimValueHash: string;
|
|
5852
5915
|
}>;
|
|
5853
|
-
declare const PayCardArtifactSchema: z.ZodObject<{
|
|
5854
|
-
userId: z.ZodString;
|
|
5855
|
-
phoneE164: z.ZodString;
|
|
5856
|
-
displayName: z.ZodString;
|
|
5857
|
-
devicePubKeySpkiB64: z.ZodString;
|
|
5858
|
-
}, "strip", z.ZodTypeAny, {
|
|
5859
|
-
phoneE164: string;
|
|
5860
|
-
userId: string;
|
|
5861
|
-
displayName: string;
|
|
5862
|
-
devicePubKeySpkiB64: string;
|
|
5863
|
-
}, {
|
|
5864
|
-
phoneE164: string;
|
|
5865
|
-
userId: string;
|
|
5866
|
-
displayName: string;
|
|
5867
|
-
devicePubKeySpkiB64: string;
|
|
5868
|
-
}>;
|
|
5869
|
-
type PayCardArtifact = z.infer<typeof PayCardArtifactSchema>;
|
|
5870
5916
|
declare const ARTIFACT_BODY_SCHEMAS: {
|
|
5871
5917
|
readonly offline_payment_authorization: z.ZodObject<{
|
|
5872
5918
|
authorization: z.ZodObject<{
|
|
@@ -6507,22 +6553,6 @@ declare const ARTIFACT_BODY_SCHEMAS: {
|
|
|
6507
6553
|
claimType: "phone_verified" | "email_verified" | "bvn_verified" | "kyc_tier" | "age_band";
|
|
6508
6554
|
claimValueHash: string;
|
|
6509
6555
|
}>;
|
|
6510
|
-
readonly pay_card: z.ZodObject<{
|
|
6511
|
-
userId: z.ZodString;
|
|
6512
|
-
phoneE164: z.ZodString;
|
|
6513
|
-
displayName: z.ZodString;
|
|
6514
|
-
devicePubKeySpkiB64: z.ZodString;
|
|
6515
|
-
}, "strip", z.ZodTypeAny, {
|
|
6516
|
-
phoneE164: string;
|
|
6517
|
-
userId: string;
|
|
6518
|
-
displayName: string;
|
|
6519
|
-
devicePubKeySpkiB64: string;
|
|
6520
|
-
}, {
|
|
6521
|
-
phoneE164: string;
|
|
6522
|
-
userId: string;
|
|
6523
|
-
displayName: string;
|
|
6524
|
-
devicePubKeySpkiB64: string;
|
|
6525
|
-
}>;
|
|
6526
6556
|
};
|
|
6527
6557
|
/** Artifact types whose body schema is fully specified and safe to dispatch. */
|
|
6528
6558
|
declare const HARDENED_ARTIFACT_TYPES: Set<ArtifactType>;
|
|
@@ -6641,154 +6671,4 @@ declare function createOfflinePaymentAuthorizationArtifactUri(input: {
|
|
|
6641
6671
|
}>;
|
|
6642
6672
|
};
|
|
6643
6673
|
|
|
6644
|
-
/**
|
|
6645
|
-
* Pay Card — Tier B of the Flur recipient-trust ladder.
|
|
6646
|
-
*
|
|
6647
|
-
* A Pay Card is a holder-signed, expiring identity attestation rendered as a
|
|
6648
|
-
* QR. When a payer scans a Pay Card and verifies its signature against the
|
|
6649
|
-
* holder's registered device-key, they obtain a trusted (userId, phoneE164,
|
|
6650
|
-
* displayName, devicePubKey) tuple they can cache locally and reuse to pay
|
|
6651
|
-
* the holder fully offline thereafter.
|
|
6652
|
-
*
|
|
6653
|
-
* Transport: the standard Flur v1 signed-artifact envelope
|
|
6654
|
-
* `flur://v1/pay_card/<base64url(canonical-json(body))>.<base64url(sig)>`
|
|
6655
|
-
*
|
|
6656
|
-
* Trust model:
|
|
6657
|
-
* - Card is signed by the holder's device key (P-256, ECDSA-SHA256, DER).
|
|
6658
|
-
* - Verifier resolves (issuer=userId, kid) to a SubjectPublicKeyInfo via
|
|
6659
|
-
* Flur's device-key registry — typically online at scan time.
|
|
6660
|
-
* - On successful verify, the scanner upserts the card into its local
|
|
6661
|
-
* verified-contact cache (Tier A) so future pays are offline.
|
|
6662
|
-
*
|
|
6663
|
-
* This module is the canonical implementation. The backend and mobile MUST
|
|
6664
|
-
* use it for build, verify, and freshness checks — no parallel implementations.
|
|
6665
|
-
*
|
|
6666
|
-
* Industry-standard defaults (configurable per call):
|
|
6667
|
-
* - TTL: 90 days from issue.
|
|
6668
|
-
* - Refresh threshold: 30 days remaining triggers a 'refresh_recommended'
|
|
6669
|
-
* freshness state.
|
|
6670
|
-
*
|
|
6671
|
-
* Field policy (enforced by {@link PayCardArtifactSchema}):
|
|
6672
|
-
* - displayName \u2264 64 chars
|
|
6673
|
-
* - phoneE164 must match /^\+[1-9]\d{7,14}$/
|
|
6674
|
-
* - devicePubKeySpkiB64 must be standard base64 (no url-safe variants),
|
|
6675
|
-
* 64..256 chars (covers P-256 SPKI = 91 chars plus forward-compat).
|
|
6676
|
-
*/
|
|
6677
|
-
|
|
6678
|
-
/** Default Pay Card lifetime (ms): 90 days. */
|
|
6679
|
-
declare const PAY_CARD_DEFAULT_TTL_MS: number;
|
|
6680
|
-
/**
|
|
6681
|
-
* When the remaining lifetime drops below this threshold (ms),
|
|
6682
|
-
* {@link inspectPayCardFreshness} returns `'refresh_recommended'`.
|
|
6683
|
-
*
|
|
6684
|
-
* Holders should refresh in the background well before hard-expiry so
|
|
6685
|
-
* a stale-card scan never blocks a payment.
|
|
6686
|
-
*/
|
|
6687
|
-
declare const PAY_CARD_REFRESH_THRESHOLD_MS: number;
|
|
6688
|
-
/** URI prefix for Pay Card artifacts. */
|
|
6689
|
-
declare const PAY_CARD_URI_PREFIX: string;
|
|
6690
|
-
/**
|
|
6691
|
-
* Inputs for {@link createPayCardArtifactUri}. Mirrors the artifact codec
|
|
6692
|
-
* inputs but pins type to `pay_card`, validates the data shape, and applies
|
|
6693
|
-
* the default TTL when `expiresAtSeconds` is omitted.
|
|
6694
|
-
*/
|
|
6695
|
-
interface CreatePayCardArtifactInput {
|
|
6696
|
-
/** Holder Flur userId (also used as the envelope issuer). */
|
|
6697
|
-
issuer: string;
|
|
6698
|
-
/** Holder device key id. */
|
|
6699
|
-
keyId: string;
|
|
6700
|
-
/** Holder device private key (raw 32-byte P-256 scalar). */
|
|
6701
|
-
privateKey: Uint8Array;
|
|
6702
|
-
/** Pay Card business payload. */
|
|
6703
|
-
data: PayCardArtifact;
|
|
6704
|
-
/** URL-safe nonce, 8..64 chars. Required for envelope uniqueness. */
|
|
6705
|
-
nonce: string;
|
|
6706
|
-
/** Override the issued-at (seconds). Defaults to now. */
|
|
6707
|
-
issuedAtSeconds?: number;
|
|
6708
|
-
/**
|
|
6709
|
-
* Override the expiry (seconds). Defaults to `issuedAt + 90 days`.
|
|
6710
|
-
*
|
|
6711
|
-
* SECURITY: a Pay Card is a holder-signed identity attestation, so a
|
|
6712
|
-
* hard expiry is mandatory at the protocol level — there is no opt-out.
|
|
6713
|
-
* Callers may shorten the TTL but cannot remove it; backend verifiers
|
|
6714
|
-
* additionally reject envelopes without `exp` (`PAY_CARD_NO_EXPIRY`).
|
|
6715
|
-
*/
|
|
6716
|
-
expiresAtSeconds?: number;
|
|
6717
|
-
}
|
|
6718
|
-
/**
|
|
6719
|
-
* Build, sign, and encode a Pay Card as a `flur://v1/pay_card/...` URI.
|
|
6720
|
-
*
|
|
6721
|
-
* Defaults the envelope's `exp` to `iat + 90 days` so callers do not need
|
|
6722
|
-
* to compute lifetimes. Refuses to emit a card whose `userId` payload
|
|
6723
|
-
* field disagrees with the envelope `issuer` \u2014 the holder must sign their
|
|
6724
|
-
* own card.
|
|
6725
|
-
*/
|
|
6726
|
-
declare function createPayCardArtifactUri(input: CreatePayCardArtifactInput): {
|
|
6727
|
-
uri: string;
|
|
6728
|
-
signed: SignedArtifact<PayCardArtifact>;
|
|
6729
|
-
};
|
|
6730
|
-
/** True when the URI is shaped as a Pay Card artifact (prefix check only). */
|
|
6731
|
-
declare function isPayCardArtifactUri(uri: string): boolean;
|
|
6732
|
-
interface DecodedPayCard {
|
|
6733
|
-
/** Validated Pay Card body (data + envelope header). */
|
|
6734
|
-
body: ArtifactBody<PayCardArtifact>;
|
|
6735
|
-
/** ASN.1 DER ECDSA P-256 signature, base64 (standard). */
|
|
6736
|
-
sig: string;
|
|
6737
|
-
/** Raw decoded envelope \u2014 useful when re-emitting or relaying. */
|
|
6738
|
-
decoded: DecodedArtifactUri;
|
|
6739
|
-
}
|
|
6740
|
-
/**
|
|
6741
|
-
* Decode a Pay Card URI without verifying its signature. Validates the URI
|
|
6742
|
-
* shape, the envelope header, and the data schema. Use when the caller wants
|
|
6743
|
-
* to inspect the card before deciding whether/how to verify it.
|
|
6744
|
-
*/
|
|
6745
|
-
declare function decodePayCardArtifact(uri: string): DecodedPayCard;
|
|
6746
|
-
/**
|
|
6747
|
-
* Verify a Pay Card URI fully:
|
|
6748
|
-
* 1. URI + envelope + data schema (via {@link decodePayCardArtifact}).
|
|
6749
|
-
* 2. Envelope expiry (unless `options.enforceExpiry === false`).
|
|
6750
|
-
* 3. ECDSA P-256 signature against the supplied holder SPKI public key.
|
|
6751
|
-
*
|
|
6752
|
-
* The caller is responsible for resolving `(issuer, kid)` to the holder's
|
|
6753
|
-
* registered SPKI public key (typically via the backend device-key registry).
|
|
6754
|
-
*/
|
|
6755
|
-
declare function verifyPayCardArtifact(uri: string, publicKeySpkiB64: string, options?: VerifyArtifactOptions): DecodedPayCard;
|
|
6756
|
-
type PayCardFreshness = 'fresh' | 'refresh_recommended' | 'expired' | 'no_expiry';
|
|
6757
|
-
/**
|
|
6758
|
-
* Classify a Pay Card by remaining lifetime. Used by holders to decide when
|
|
6759
|
-
* to re-fetch a freshly-signed card from the backend, and by scanners to
|
|
6760
|
-
* decide whether to prompt the holder to refresh.
|
|
6761
|
-
*
|
|
6762
|
-
* - `'expired'` : envelope.exp \u2264 now
|
|
6763
|
-
* - `'refresh_recommended'` : 0 < remaining \u2264 PAY_CARD_REFRESH_THRESHOLD_MS
|
|
6764
|
-
* - `'fresh'` : remaining > PAY_CARD_REFRESH_THRESHOLD_MS
|
|
6765
|
-
* - `'no_expiry'` : envelope omits `exp` (non-production cards only)
|
|
6766
|
-
*/
|
|
6767
|
-
declare function inspectPayCardFreshness(decoded: DecodedPayCard, nowMs?: number): PayCardFreshness;
|
|
6768
|
-
/**
|
|
6769
|
-
* Compute the canonical body bytes a backend must sign when issuing a
|
|
6770
|
-
* Pay Card on behalf of the holder via a *server-side* signing path.
|
|
6771
|
-
*
|
|
6772
|
-
* This export exists so a backend (which holds neither the holder's private
|
|
6773
|
-
* key nor a parallel envelope implementation) can call into the SDK to
|
|
6774
|
-
* obtain the exact bytes to sign with a hardware-backed device key abstraction.
|
|
6775
|
-
* Mobile clients that sign locally should use {@link createPayCardArtifactUri}
|
|
6776
|
-
* instead.
|
|
6777
|
-
*
|
|
6778
|
-
* Returned bytes are the same input passed to ECDSA P-256(SHA-256). Callers
|
|
6779
|
-
* MUST keep this contract \u2014 changing the signing input is a protocol break.
|
|
6780
|
-
*/
|
|
6781
|
-
declare function buildPayCardSigningInput(input: {
|
|
6782
|
-
issuer: string;
|
|
6783
|
-
keyId: string;
|
|
6784
|
-
data: PayCardArtifact;
|
|
6785
|
-
nonce: string;
|
|
6786
|
-
issuedAtSeconds?: number;
|
|
6787
|
-
/** See {@link CreatePayCardArtifactInput.expiresAtSeconds}. */
|
|
6788
|
-
expiresAtSeconds?: number;
|
|
6789
|
-
}): {
|
|
6790
|
-
body: ArtifactBody<PayCardArtifact>;
|
|
6791
|
-
bodyBytes: Uint8Array;
|
|
6792
|
-
};
|
|
6793
|
-
|
|
6794
|
-
export { ACCOUNT_FUNDED_OAC_MAX_TTL_MS, ACCOUNT_STATUSES, ACCOUNT_TYPES, ADDITIONAL_DATA_SUBFIELD, ARTIFACT_BODY_SCHEMAS, ARTIFACT_TYPES, type Account, type AccountActivityItem, type AccountMembership, AccountMembershipSchema, AccountSchema, type AccountStatus, type AccountSummaryResponse, type AccountType, type AccountsClient, type AccountsClientOptions, type AddMemberInput, type AdditionalData, type ApiCredentialPublic, ApiCredentialPublicSchema, type ApiCredentialsAdminClient, type ArtifactBody, type ArtifactHeader, ArtifactHeaderSchema, type ArtifactType, type AtomicRedeemReceiptInput, type AtomicRedeemResponse, type AttestationSecurityLevel, AttestationSecurityLevelSchema, type AuthLogoutInput, type AuthRefreshInput, type AuthRefreshResponse, type AuthorizeSendWithBiometricInput, type AuthorizedOptions, type BiometricSigner, type BuildPassInput, type BuildReceiptInput, type BuildRedemptionInput, CLAIM_DOMAIN_V2, COLLECTION_INTENT_STATUSES, COLLECTION_PAYMENT_STATUSES, CONSUMER_OAC_DOMAIN, CONSUMER_OAC_QR_PREFIX, CONSUMER_OFFLINE_CLAIM_SUBMIT_GRACE_MS, CONSUMER_PAYMENT_REQUEST_DOMAIN, CONSUMER_SETTLEMENT_DOMAIN, CONSUMER_SETTLEMENT_RECEIPT_QR_PREFIX, CUSTODIAL_MODES, type CanonicalClaimInput, type CashNamespace, type ClaimSignature, type CollectionIntent, CollectionIntentSchema, type CollectionPayment, type CollectionPaymentResult, CollectionPaymentResultSchema, CollectionPaymentSchema, type CollectionReportSummary, CollectionReportSummarySchema, type CollectionStatement, CollectionStatementSchema, type CollectionsClient, type CollectionsClientOptions, type ConsumerCollectionsClient, type ConsumerOAC, type OACRecord as ConsumerOACRecord, OACRecordSchema as ConsumerOACRecordSchema, ConsumerOACSchema, type ConsumerPaymentClaim, ConsumerPaymentClaimSchema, type ConsumerPaymentRequestEnvelope, ConsumerPaymentRequestEnvelopeSchema, type ConsumerSettleResult, ConsumerSettleResultSchema, type ConsumerSettlement, ConsumerSettlementSchema, type ConsumerWithdrawalsClient, type ConsumerWithdrawalsClientOptions, type CreateBusinessAccountInput, type CreateCollectionIntentInput, CreateCollectionIntentInputSchema, type CreatePayCardArtifactInput, type CreatePayLinkResponse, type CreatePayoutDestinationInput, CreatePayoutDestinationInputSchema, type CreatePayoutInput, CreatePayoutInputSchema, type CreateTransferOptions, type CreateWithdrawalInput, CreateWithdrawalInputSchema, type CreateWithdrawalResult, CreateWithdrawalResultSchema, type CustodialMode, type DecodedArtifactUri, type DecodedOfflineSmsSettleToken, type DecodedPayCard, type DeviceKeyAlg, DeviceKeyAlgSchema, type DeviceKeyRecord, DeviceKeyRecordSchema, type DeviceTrustState, FIELD, FLUR_ARTIFACT_URI_PREFIX, FLUR_ARTIFACT_URI_SCHEME, FLUR_ARTIFACT_VERSION, FlurApiError, FlurArtifactError, FlurCapExceededError, FlurClient, type FlurClientOptions, FlurError, type FlurErrorCode, FlurExpiredError, type FlurHandle, type FlurInitOptions, type FlurOfflineSettlementsClient, type FlurPartnerClient, type FlurPaymentEvent, FlurReplayError, HARDENED_ARTIFACT_TYPES, type HmacFetchOptions, IdentityArtifactSchema, type IngestFundingResult, IngestFundingResultSchema, type IssueAccountOacInput, IssueAccountOacInputSchema, type IssueOfflineTokenInput, type IssuePassInput, type IssueReceiptInput, type IssuerTrustBundle, IssuerTrustBundleSchema, type IssuerTrustKey, IssuerTrustKeySchema, LedgerJournalEntryArtifactSchema, type ListPassesInput, type ListPassesResponse, type ListPayoutDestinationsResult, ListPayoutDestinationsResultSchema, type ListReceiptsInput, type ListReceiptsResponse, type ListTransactionsOptions, MEMBERSHIP_ROLES, MERCHANT_PAYOUT_STATUSES, MERCHANT_PROFILE_STATUSES, type MeOfflineClient, type MeOfflineClientOptions, type MembershipRole, type MerchantAccountInfo, type MerchantPayout, MerchantPayoutSchema, type MerchantProfile, MerchantProfileSchema, type MintedApiCredential, MintedApiCredentialSchema, type Money, NGN_CURRENCY_CODE, NG_COUNTRY_CODE, NQRParseError, type NQRPayloadInput, NqrPaymentRequestArtifactSchema, type OAC, OACSchema, OAC_DEFAULT_CUMULATIVE_KOBO, OAC_DEFAULT_PER_TX_KOBO, OAC_DEFAULT_VALIDITY_MS, OFFLINE_CLAIM_SMS_PREFIX, OFFLINE_SMS_SETTLE_DOMAIN, OFFLINE_SMS_SETTLE_HEADER_BYTES, OFFLINE_SMS_SETTLE_PREFIX, OFFLINE_SMS_SETTLE_SIGNATURE_BYTES, OFFLINE_SMS_SETTLE_TOKEN_BYTES, OFFLINE_SMS_SETTLE_VERSION, type OacOfflineIdentity, type OfflineClaimAlgorithm, OfflineClaimArtifactSchema, type OfflineClaimSigner, type OfflinePaymentAuthorization, type OfflinePaymentAuthorizationArtifact, OfflinePaymentAuthorizationArtifactSchema, OfflinePaymentAuthorizationSchema, type OfflinePaymentRequest, OfflinePaymentRequestSchema, type OfflineSmsSettleInput, type OfflineSmsSettleSigner, type OfflineStatusResult, OfflineStatusResultSchema, type OfflineToken, OfflineTokenSchema, type OnboardingCompleteInput, type OnboardingCompleteResponse, type OnboardingFallback, type OnboardingRiskReason, type OnboardingStartInput, type OnboardingStartResponse, type P256EnrollmentChallengeInput, P256EnrollmentChallengeInputSchema, type P256EnrollmentChallengeResult, P256EnrollmentChallengeResultSchema, PARTNER_FUNDING_DIRECTIONS, PARTNER_FUNDING_STATUSES, PARTNER_KINDS, PARTNER_PROFILE_STATUSES, PARTNER_SCOPES, PASS_KINDS, PASS_STATES, PAYLOAD_FORMAT_INDICATOR_VALUE, PAYOUT_DESTINATION_STATUSES, PAY_CARD_DEFAULT_TTL_MS, PAY_CARD_REFRESH_THRESHOLD_MS, PAY_CARD_URI_PREFIX, POINT_OF_INITIATION, type ParsedNQR, type PartnerClientOptions, type PartnerCollectionsClient, type PartnerFunding, type PartnerFundingClient, type PartnerFundingDirection, type PartnerFundingEventInput, PartnerFundingEventInputSchema, PartnerFundingSchema, type PartnerFundingStatus, type PartnerKind, type PartnerProfile, type PartnerProfileAdminClient, type PartnerProfileAdminClientOptions, PartnerProfileSchema, type PartnerProfileStatus, type PartnerScope, type PartnerSignResult, type Pass, PassArtifactSchema, type PassKind, type PassMetadata, PassMetadataSchema, PassSchema, type PassState, type PassesClient, type PassesClientOptions, type PayCardArtifact, PayCardArtifactSchema, type PayCardFreshness, type PayCollectionInput, PayCollectionInputSchema, type PayCollectionOptions, type PayCollectionResponse, type PaymentClaim, PaymentClaimSchema, PaymentIntentArtifactSchema, type PayoutDestination, PayoutDestinationSchema, type PayoutDestinationStatus, type PayoutEventInput, PayoutEventInputSchema, type PinSetInput, type PinVerifyInput, type ProviderEventInput, ProviderEventInputSchema, type ProviderEventRecord, ProviderEventRecordSchema, type PublicCollectionIntent, PublicCollectionIntentSchema, type PushPlatform, type PushRegisterInput, RECEIPT_CHANNELS, RECEIPT_KINDS, REPLAY_WINDOW_MS, type Receipt, type ReceiptArtifact, ReceiptArtifactSchema, type ReceiptChannel, type ReceiptKind, type ReceiptPayload, ReceiptPayloadSchema, ReceiptSchema, type ReceiptsClient, type ReceiptsClientOptions, type RecipientResolveInput, type RecipientResolveResponse, type ReconciliationReport, ReconciliationReportSchema, type RecordPayoutEventResult, RecordPayoutEventResultSchema, type RedeemPassResponse, type Redemption, RedemptionSchema, type RegisterDeviceInput, type RegisterDeviceKeyP256Input, RegisterDeviceKeyP256InputSchema, type RegisterDeviceResponse, type RegisterSendDeviceKeyInput, type ResolveCollectionOptions, type ResolveCollectionResponse, type ResolvePayLinkResponse, ReversalRecordArtifactSchema, RevokeDeviceKeyInputSchema, type RevokePassInput, type RoutingHint, SETTLEMENT_SCHEDULES, type SendChallengeInput, type SendChallengeResponse, type SendMoneyInput, type SendMoneyOptions, type SendVerifyInput, type SendVerifyResponse, type SettleResponse, SettleResponseSchema, type Settlement, SettlementRecordArtifactSchema, SettlementSchema, type SignedArtifact, type SignedConsumerOAC, SignedConsumerOACSchema, type SignerPublicKey, StatementArtifactSchema, type SubscribeOptions, type TLVField, type TransactionDetailResponse, type TransactionDirection, type TransactionsListResponse, type TransferInput, type TransferResponse, type TransferStatus, type TrustedIssuerKey, type UnsignedConsumerPaymentRequest, type UnsignedOAC, type UnsignedOfflinePaymentAuthorization, type UnsignedOfflinePaymentRequest, type UnsignedPass, type UnsignedReceipt, type UnsignedRedemption, type UpsertMerchantProfileInput, UpsertMerchantProfileInputSchema, type UpsertPartnerProfileInput, UpsertPartnerProfileInputSchema, type VerifiedArtifact, type VerifyArtifactOptions, type VerifyClaimSignatureInput, type VerifyOacOfflineOptions, type VerifyOacOfflineResult, WITHDRAWAL_STATES, type Withdrawal, WithdrawalSchema, type WithdrawalState, base64UrlDecode, base64UrlEncode, bodySha256Hex, buildArtifactBody, buildAuthorization, buildConsumerPaymentRequest, buildOAC, buildPass, buildPayCardSigningInput, buildPaymentRequest, buildReceipt, buildRedemption, buildSmsSettleHeader, domainTag as buildSmsSettleSignedBytes, canonicalClaimSigningBytes, canonicalClaimSigningPayload, canonicalJSONBytes, canonicalJSONStringify, canonicalRequestString, computeConsumerClaimEncounterId, computeEncounterId, constantTimeEqual, consumerOacSigningPayload, consumerPaymentRequestSigningBytes, consumerPaymentRequestSigningPayload, consumerSettlementSigningPayload, crc16ccitt, crc16ccittHex, createAccountsClient, createApiCredentialsAdminClient, createArtifactUri, createCollectionsClient, createConsumerCollectionsClient, createConsumerWithdrawalsClient, createFlurPartnerClient, createHmacFetch, createMeOfflineClient, createOfflinePaymentAuthorizationArtifactUri, createOfflineSettlementsClient, createPartnerCollectionsClient, createPartnerFundingClient, createPartnerProfileAdminClient, createPassesClient, createPayCardArtifactUri, createReceiptArtifactUri, createReceiptsClient, createSoftwareP256Signer, decodeArtifactUri, decodeAuthorizationQR, decodeBase45, decodeConsumerSettlementReceiptQR, decodeOfflineClaimSmsMessage, decodeOfflineSmsSettleToken, decodePayCardArtifact, decodePaymentRequestQR, decodeUnverifiedConsumerOacQR, decodeUnverifiedConsumerSettlementReceiptQR, derToRawP256Signature, encodeArtifactUri, encodeAuthorizationQR, encodeBase45, encodeConsumerOacQR, encodeConsumerSettlementReceiptQR, encodeNQR, encodeOfflineClaimSmsMessage, encodeOfflineSmsSettleToken, encodePaymentRequestQR, extractOfflineClaimSmsToken, extractOfflineSmsSettleToken, formatAmount, generateDynamicQR, generateStaticQR, init, inspectPayCardFreshness, isConsumerOacQR, isConsumerPaymentRequestExpired, isHardenedArtifactType, isKnownArtifactType, isPassWithinValidity, isPayCardArtifactUri, moneyMinorToNumber, normalizeE164, parseAmountInput, parseNQR, parseQR, readTLV, routingHint, signArtifact, signAuthorization, signConsumerPaymentRequest, signOAC, signPartnerRequest, signPass, signPaymentRequest, signReceipt, signRedemption, signRequestHMAC, verifyArtifactSignature, verifyArtifactUri, verifyAuthorization, verifyClaimSignature, verifyConsumerPaymentRequest, verifyConsumerSettlement, verifyConsumerSettlementReceiptQR, verifyOAC, verifyOacOffline, verifyOfflineSmsSettleToken, verifyPass, verifyPayCardArtifact, verifyPaymentRequest, verifyReceipt, verifyRedemption, verifyRequestHMAC, writeTLV };
|
|
6674
|
+
export { ACCOUNT_FUNDED_OAC_MAX_TTL_MS, ACCOUNT_STATUSES, ACCOUNT_TYPES, ADDITIONAL_DATA_SUBFIELD, ARTIFACT_BODY_SCHEMAS, ARTIFACT_TYPES, type Account, type AccountActivityItem, type AccountMembership, AccountMembershipSchema, AccountSchema, type AccountStatus, type AccountSummaryResponse, type AccountType, type AccountsClient, type AccountsClientOptions, type AddMemberInput, type AdditionalData, type ApiCredentialPublic, ApiCredentialPublicSchema, type ApiCredentialsAdminClient, type ArtifactBody, type ArtifactHeader, ArtifactHeaderSchema, type ArtifactType, type AtomicRedeemReceiptInput, type AtomicRedeemResponse, type AttestationSecurityLevel, AttestationSecurityLevelSchema, type AuthLogoutInput, type AuthRefreshInput, type AuthRefreshResponse, type AuthorizeSendWithBiometricInput, type AuthorizedOptions, type BiometricSigner, type BuildPassInput, type BuildReceiptInput, type BuildRedemptionInput, CLAIM_DOMAIN_V2, COLLECTION_INTENT_STATUSES, COLLECTION_PAYMENT_STATUSES, CONSUMER_OAC_DOMAIN, CONSUMER_OAC_QR_PREFIX, CONSUMER_OFFLINE_CLAIM_SUBMIT_GRACE_MS, CONSUMER_PAYMENT_REQUEST_DOMAIN, CONSUMER_SETTLEMENT_DOMAIN, CONSUMER_SETTLEMENT_RECEIPT_QR_PREFIX, CUSTODIAL_MODES, type CanonicalClaimInput, type CashNamespace, type ClaimSignature, type CollectionIntent, CollectionIntentSchema, type CollectionPayment, type CollectionPaymentResult, CollectionPaymentResultSchema, CollectionPaymentSchema, type CollectionReportSummary, CollectionReportSummarySchema, type CollectionStatement, CollectionStatementSchema, type CollectionsClient, type CollectionsClientOptions, type ConsumerCollectionsClient, type ConsumerOAC, type OACRecord as ConsumerOACRecord, OACRecordSchema as ConsumerOACRecordSchema, ConsumerOACSchema, type ConsumerPaymentClaim, ConsumerPaymentClaimSchema, type ConsumerPaymentRequestEnvelope, ConsumerPaymentRequestEnvelopeSchema, type ConsumerSettleResult, ConsumerSettleResultSchema, type ConsumerSettlement, ConsumerSettlementSchema, type ConsumerWithdrawalsClient, type ConsumerWithdrawalsClientOptions, type CreateBusinessAccountInput, type CreateCollectionIntentInput, CreateCollectionIntentInputSchema, type CreatePayLinkResponse, type CreatePayoutDestinationInput, CreatePayoutDestinationInputSchema, type CreatePayoutInput, CreatePayoutInputSchema, type CreateTransferOptions, type CreateWithdrawalInput, CreateWithdrawalInputSchema, type CreateWithdrawalResult, CreateWithdrawalResultSchema, type CustodialMode, type DecodedArtifactUri, type DecodedOfflineSmsSettleToken, type DeviceKeyAlg, DeviceKeyAlgSchema, type DeviceKeyRecord, DeviceKeyRecordSchema, type DeviceTrustState, FIELD, FLUR_ARTIFACT_URI_PREFIX, FLUR_ARTIFACT_URI_SCHEME, FLUR_ARTIFACT_VERSION, FlurApiError, FlurArtifactError, FlurCapExceededError, FlurClient, type FlurClientOptions, FlurError, type FlurErrorCode, FlurExpiredError, type FlurHandle, type FlurInitOptions, type FlurOfflineSettlementsClient, type FlurPartnerClient, type FlurPaymentEvent, FlurReplayError, HARDENED_ARTIFACT_TYPES, type HmacFetchOptions, IdentityArtifactSchema, type IngestFundingResult, IngestFundingResultSchema, type IssueAccountOacInput, IssueAccountOacInputSchema, type IssueOfflineTokenInput, type IssuePassInput, type IssueReceiptInput, type IssuerTrustBundle, IssuerTrustBundleSchema, type IssuerTrustKey, IssuerTrustKeySchema, LedgerJournalEntryArtifactSchema, type ListPassesInput, type ListPassesResponse, type ListPayoutDestinationsResult, ListPayoutDestinationsResultSchema, type ListReceiptsInput, type ListReceiptsResponse, type ListTransactionsOptions, MEMBERSHIP_ROLES, MERCHANT_PAYOUT_STATUSES, MERCHANT_PROFILE_STATUSES, type MeOfflineClient, type MeOfflineClientOptions, type MembershipRole, type MerchantAccountInfo, type MerchantPayout, MerchantPayoutSchema, type MerchantProfile, MerchantProfileSchema, type MintedApiCredential, MintedApiCredentialSchema, type Money, NGN_CURRENCY_CODE, NG_COUNTRY_CODE, NQRParseError, type NQRPayloadInput, NqrPaymentRequestArtifactSchema, type OAC, OACSchema, OAC_DEFAULT_CUMULATIVE_KOBO, OAC_DEFAULT_PER_TX_KOBO, OAC_DEFAULT_VALIDITY_MS, OFFLINE_CLAIM_SMS_PREFIX, OFFLINE_SMS_SETTLE_DOMAIN, OFFLINE_SMS_SETTLE_HEADER_BYTES, OFFLINE_SMS_SETTLE_PREFIX, OFFLINE_SMS_SETTLE_SIGNATURE_BYTES, OFFLINE_SMS_SETTLE_TOKEN_BYTES, OFFLINE_SMS_SETTLE_VERSION, type OacOfflineIdentity, type OacPresentmentRequest, OacPresentmentRequestSchema, type OfflineClaimAlgorithm, OfflineClaimArtifactSchema, type OfflineClaimSigner, type OfflinePaymentAuthorization, type OfflinePaymentAuthorizationArtifact, OfflinePaymentAuthorizationArtifactSchema, OfflinePaymentAuthorizationSchema, type OfflinePaymentRequest, OfflinePaymentRequestSchema, type OfflineSmsSettleInput, type OfflineSmsSettleSigner, type OfflineStatusResult, OfflineStatusResultSchema, type OfflineToken, OfflineTokenSchema, type OnboardingCompleteInput, type OnboardingCompleteResponse, type OnboardingFallback, type OnboardingRiskReason, type OnboardingStartInput, type OnboardingStartResponse, type P256EnrollmentChallengeInput, P256EnrollmentChallengeInputSchema, type P256EnrollmentChallengeResult, P256EnrollmentChallengeResultSchema, PARTNER_FUNDING_DIRECTIONS, PARTNER_FUNDING_STATUSES, PARTNER_KINDS, PARTNER_PROFILE_STATUSES, PARTNER_SCOPES, PASS_KINDS, PASS_STATES, PAYLOAD_FORMAT_INDICATOR_VALUE, PAYOUT_DESTINATION_STATUSES, POINT_OF_INITIATION, type ParsedNQR, type PartnerClientOptions, type PartnerCollectionsClient, type PartnerFunding, type PartnerFundingClient, type PartnerFundingDirection, type PartnerFundingEventInput, PartnerFundingEventInputSchema, PartnerFundingSchema, type PartnerFundingStatus, type PartnerKind, type PartnerProfile, type PartnerProfileAdminClient, type PartnerProfileAdminClientOptions, PartnerProfileSchema, type PartnerProfileStatus, type PartnerScope, type PartnerSignResult, type Pass, PassArtifactSchema, type PassKind, type PassMetadata, PassMetadataSchema, PassSchema, type PassState, type PassesClient, type PassesClientOptions, type PayCollectionInput, PayCollectionInputSchema, type PayCollectionOptions, type PayCollectionResponse, type PaymentClaim, PaymentClaimSchema, PaymentIntentArtifactSchema, type PayoutDestination, PayoutDestinationSchema, type PayoutDestinationStatus, type PayoutEventInput, PayoutEventInputSchema, type PinSetInput, type PinVerifyInput, type ProviderEventInput, ProviderEventInputSchema, type ProviderEventRecord, ProviderEventRecordSchema, type PublicCollectionIntent, PublicCollectionIntentSchema, type PushPlatform, type PushRegisterInput, RECEIPT_CHANNELS, RECEIPT_KINDS, REPLAY_WINDOW_MS, type Receipt, type ReceiptArtifact, ReceiptArtifactSchema, type ReceiptChannel, type ReceiptKind, type ReceiptPayload, ReceiptPayloadSchema, ReceiptSchema, type ReceiptsClient, type ReceiptsClientOptions, type RecipientResolveInput, type RecipientResolveResponse, type ReconciliationReport, ReconciliationReportSchema, type RecordPayoutEventResult, RecordPayoutEventResultSchema, type RedeemPassResponse, type Redemption, RedemptionSchema, type RegisterDeviceInput, type RegisterDeviceKeyP256Input, RegisterDeviceKeyP256InputSchema, type RegisterDeviceResponse, type RegisterSendDeviceKeyInput, type ResolveCollectionOptions, type ResolveCollectionResponse, type ResolvePayLinkResponse, ReversalRecordArtifactSchema, RevokeDeviceKeyInputSchema, type RevokePassInput, type RoutingHint, SETTLEMENT_SCHEDULES, type SendChallengeInput, type SendChallengeResponse, type SendMoneyInput, type SendMoneyOptions, type SendVerifyInput, type SendVerifyResponse, type SettleResponse, SettleResponseSchema, type Settlement, SettlementRecordArtifactSchema, SettlementSchema, type SignedArtifact, type SignedConsumerOAC, SignedConsumerOACSchema, type SignerPublicKey, StatementArtifactSchema, type SubscribeOptions, type TLVField, type TransactionDetailResponse, type TransactionDirection, type TransactionsListResponse, type TransferInput, type TransferResponse, type TransferStatus, type TrustedIssuerKey, type UnsignedConsumerPaymentRequest, type UnsignedOAC, type UnsignedOfflinePaymentAuthorization, type UnsignedOfflinePaymentRequest, type UnsignedPass, type UnsignedReceipt, type UnsignedRedemption, type UpsertMerchantProfileInput, UpsertMerchantProfileInputSchema, type UpsertPartnerProfileInput, UpsertPartnerProfileInputSchema, type VerifiedArtifact, type VerifyArtifactOptions, type VerifyClaimSignatureInput, type VerifyOacOfflineOptions, type VerifyOacOfflineResult, WITHDRAWAL_STATES, type Withdrawal, WithdrawalSchema, type WithdrawalState, base64UrlDecode, base64UrlEncode, bodySha256Hex, buildArtifactBody, buildAuthorization, buildConsumerPaymentRequest, buildOAC, buildPass, buildPaymentRequest, buildReceipt, buildRedemption, buildSmsSettleHeader, domainTag as buildSmsSettleSignedBytes, canonicalClaimSigningBytes, canonicalClaimSigningPayload, canonicalJSONBytes, canonicalJSONStringify, canonicalRequestString, computeConsumerClaimEncounterId, computeEncounterId, constantTimeEqual, consumerOacSigningPayload, consumerPaymentRequestSigningBytes, consumerPaymentRequestSigningPayload, consumerSettlementSigningPayload, crc16ccitt, crc16ccittHex, createAccountsClient, createApiCredentialsAdminClient, createArtifactUri, createCollectionsClient, createConsumerCollectionsClient, createConsumerWithdrawalsClient, createFlurPartnerClient, createHmacFetch, createMeOfflineClient, createOfflinePaymentAuthorizationArtifactUri, createOfflineSettlementsClient, createPartnerCollectionsClient, createPartnerFundingClient, createPartnerProfileAdminClient, createPassesClient, createReceiptArtifactUri, createReceiptsClient, createSoftwareP256Signer, decodeArtifactUri, decodeAuthorizationQR, decodeBase45, decodeConsumerOacRequest, decodeConsumerSettlementReceiptQR, decodeOfflineClaimSmsMessage, decodeOfflineSmsSettleToken, decodePaymentRequestQR, decodeUnverifiedConsumerOacQR, decodeUnverifiedConsumerSettlementReceiptQR, derToRawP256Signature, encodeArtifactUri, encodeAuthorizationQR, encodeBase45, encodeConsumerOacQR, encodeConsumerSettlementReceiptQR, encodeNQR, encodeOfflineClaimSmsMessage, encodeOfflineSmsSettleToken, encodePaymentRequestQR, extractOfflineClaimSmsToken, extractOfflineSmsSettleToken, formatAmount, generateDynamicQR, generateStaticQR, init, isConsumerOacQR, isConsumerPaymentRequestExpired, isHardenedArtifactType, isKnownArtifactType, isPassWithinValidity, moneyMinorToNumber, normalizeE164, parseAmountInput, parseNQR, parseQR, readTLV, routingHint, signArtifact, signAuthorization, signConsumerPaymentRequest, signOAC, signPartnerRequest, signPass, signPaymentRequest, signReceipt, signRedemption, signRequestHMAC, verifyArtifactSignature, verifyArtifactUri, verifyAuthorization, verifyClaimSignature, verifyConsumerPaymentRequest, verifyConsumerSettlement, verifyConsumerSettlementReceiptQR, verifyOAC, verifyOacOffline, verifyOfflineSmsSettleToken, verifyPass, verifyPaymentRequest, verifyReceipt, verifyRedemption, verifyRequestHMAC, writeTLV };
|