squarefi-bff-api-module 1.36.52 → 1.36.53

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.
@@ -4236,6 +4236,8 @@ export interface paths {
4236
4236
  * - Missing required fields
4237
4237
  * - Invalid reference_id format
4238
4238
  * - Invalid amount (must be positive number)
4239
+ * - `TOPUP_BELOW_MINIMUM` — credited amount is below the program's
4240
+ * `min_topup` threshold (`error.details.min_topup`, program currency)
4239
4241
  * */
4240
4242
  400: {
4241
4243
  headers: {
@@ -3632,7 +3632,10 @@ export interface paths {
3632
3632
  };
3633
3633
  content?: never;
3634
3634
  };
3635
- /** @description Validation error */
3635
+ /** @description Validation error. Includes `TOPUP_BELOW_MINIMUM` — credited amount is
3636
+ * below the program's `min_topup` threshold (`error.details.min_topup`,
3637
+ * program currency). No order created, wallet not debited.
3638
+ * */
3636
3639
  400: {
3637
3640
  headers: {
3638
3641
  [name: string]: unknown;
@@ -4283,6 +4286,9 @@ export interface paths {
4283
4286
  * - Invalid reference_id format
4284
4287
  * - Invalid amount (must be positive number)
4285
4288
  * - Insufficient wallet balance (`INSUFFICIENT_BALANCE`)
4289
+ * - `TOPUP_BELOW_MINIMUM` — credited amount is below the program's
4290
+ * `min_topup` threshold; `error.details.min_topup` carries the
4291
+ * threshold (program currency). No order created, wallet not debited.
4286
4292
  * */
4287
4293
  400: {
4288
4294
  headers: {
@@ -13543,6 +13549,8 @@ export interface components {
13543
13549
  card_issuing_fee?: number | null;
13544
13550
  card_monthly_fee?: number | null;
13545
13551
  initial_topup?: number | null;
13552
+ /** @description Minimum top-up amount in program currency, compared against the credited amount (0 = no minimum) */
13553
+ min_topup?: number;
13546
13554
  card_design?: {
13547
13555
  [key: string]: unknown;
13548
13556
  } | null;
@@ -115,6 +115,17 @@ export declare namespace API {
115
115
  card_issuing_fee: number | null;
116
116
  card_monthly_fee: number | null;
117
117
  initial_topup: number | null;
118
+ /**
119
+ * Minimum top-up in the program's currency, compared against the amount
120
+ * CREDITED to the card (after fees and conversion) — the same figure the
121
+ * server checks before it refuses a deposit with `TOPUP_BELOW_MINIMUM`.
122
+ * `0` means the program sets no minimum. Does not apply to the initial
123
+ * top-up at issuance.
124
+ *
125
+ * Optional on the type because programs served by a backend older than
126
+ * the `issuing_programs.min_topup` migration omit it.
127
+ */
128
+ min_topup?: number;
118
129
  status?: IssuingProgramStatus | string;
119
130
  }
120
131
  }
@@ -270,7 +281,34 @@ export declare namespace API {
270
281
  adjustment_type: string;
271
282
  review_status: string;
272
283
  group: string;
284
+ /**
285
+ * What actually left the card: `billing_amount` plus `fee` for a debit
286
+ * (minus it for a credit, which arrives net of what the vendor keeps).
287
+ * Equals `billing_amount` when no fee sits inside the operation, so it is
288
+ * the figure to show as the transaction's amount.
289
+ */
273
290
  total_amount: number;
291
+ /**
292
+ * Fee charged INSIDE this operation, in billing currency. `0` for vendors
293
+ * that bill fees as their own transactions — those arrive as separate rows
294
+ * with `transaction_type: FEE`. Optional: older backends omit it.
295
+ */
296
+ fee?: number;
297
+ /** Vendor's itemisation of `fee`; empty when it gave none. */
298
+ fee_details?: TransactionFee[];
299
+ /**
300
+ * Units of billing currency per unit of transaction currency, so
301
+ * `transaction_amount * conversion_rate ≈ billing_amount`. 1 when the
302
+ * currencies match.
303
+ */
304
+ conversion_rate?: number;
305
+ }
306
+ /** One line of a transaction's fee itemisation (`TransactionItem.fee_details`). */
307
+ interface TransactionFee {
308
+ amount: number;
309
+ currency: string;
310
+ /** Vendor's own fee code — no cross-vendor meaning. */
311
+ type: string | null;
274
312
  }
275
313
  interface TransactionsList {
276
314
  data: TransactionItem[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.36.52",
3
+ "version": "1.36.53",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",