squarefi-bff-api-module 1.36.7 → 1.36.8
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/api/counterparties.d.ts +1 -0
- package/dist/api/counterparties.js +4 -0
- package/dist/api/types/autogen/apiV1External.types.d.ts +10 -4
- package/dist/api/types/autogen/apiV1Frontend.types.d.ts +94 -4
- package/dist/api/types/autogen/apiV1Tenant.types.d.ts +10 -4
- package/dist/api/types/types.d.ts +6 -0
- package/package.json +1 -1
|
@@ -11,5 +11,6 @@ export declare const counterparties: {
|
|
|
11
11
|
create: ({ wallet_id: _wallet_id, external_banking_data, external_crypto_data, internal_data, ...rest }: API.Counterparties.Destination.Create.Request) => Promise<API.Counterparties.Destination.Create.Response>;
|
|
12
12
|
update: ({ counterparty_destination_id, wallet_id: _wallet_id, counterparty_account_id: _counterparty_account_id, ...data }: API.Counterparties.Destination.Update.Request) => Promise<API.Counterparties.Destination.Update.Response>;
|
|
13
13
|
delete: ({ counterparty_destination_id, request_id, }: API.Counterparties.Destination.Delete.Request) => Promise<void>;
|
|
14
|
+
internalTransfer: ({ counterparty_destination_id, }: API.Counterparties.Destination.InternalTransfer.Request) => Promise<API.Counterparties.Destination.InternalTransfer.Response>;
|
|
14
15
|
};
|
|
15
16
|
};
|
|
@@ -68,5 +68,9 @@ export const counterparties = {
|
|
|
68
68
|
params: { request_id },
|
|
69
69
|
});
|
|
70
70
|
},
|
|
71
|
+
internalTransfer: async ({ counterparty_destination_id, }) => {
|
|
72
|
+
const res = await apiClientV1Frontend.getRequest(`/frontend/counterparty/destinations/${counterparty_destination_id}/internal-transfer`);
|
|
73
|
+
return res.data;
|
|
74
|
+
},
|
|
71
75
|
},
|
|
72
76
|
};
|
|
@@ -6954,7 +6954,7 @@ export interface components {
|
|
|
6954
6954
|
/** @description Routing/sort code */
|
|
6955
6955
|
routing_number?: string | null;
|
|
6956
6956
|
/** @description Bank name */
|
|
6957
|
-
bank_name
|
|
6957
|
+
bank_name: string | null;
|
|
6958
6958
|
/** @description SWIFT/BIC code */
|
|
6959
6959
|
swift_bic?: string | null;
|
|
6960
6960
|
/** @description IBAN */
|
|
@@ -6964,6 +6964,8 @@ export interface components {
|
|
|
6964
6964
|
/** @description Additional notes/reference */
|
|
6965
6965
|
note?: string | null;
|
|
6966
6966
|
address?: components["schemas"]["BankingAddress"];
|
|
6967
|
+
/** Format: date-time */
|
|
6968
|
+
created_at: string;
|
|
6967
6969
|
} | null;
|
|
6968
6970
|
/** @description Currency reference (short) */
|
|
6969
6971
|
CurrencyRef: {
|
|
@@ -6982,7 +6984,7 @@ export interface components {
|
|
|
6982
6984
|
/** Format: uuid */
|
|
6983
6985
|
id?: string;
|
|
6984
6986
|
/** @description Blockchain address */
|
|
6985
|
-
address
|
|
6987
|
+
address: string;
|
|
6986
6988
|
/**
|
|
6987
6989
|
* Format: uuid
|
|
6988
6990
|
* @description Currency UUID
|
|
@@ -6990,7 +6992,9 @@ export interface components {
|
|
|
6990
6992
|
currency_id?: string;
|
|
6991
6993
|
/** @description Memo/tag (for XRP, XLM, etc.) */
|
|
6992
6994
|
memo?: string | null;
|
|
6993
|
-
currency
|
|
6995
|
+
currency: components["schemas"]["CurrencyRef"];
|
|
6996
|
+
/** Format: date-time */
|
|
6997
|
+
created_at: string;
|
|
6994
6998
|
} | null;
|
|
6995
6999
|
/** @description Internal destination payload — the receiver wallet on the same platform. Populated when type is INTERNAL; null otherwise. */
|
|
6996
7000
|
CounterpartyInternalData: {
|
|
@@ -6998,9 +7002,11 @@ export interface components {
|
|
|
6998
7002
|
* Format: uuid
|
|
6999
7003
|
* @description Target (receiver) wallet uuid
|
|
7000
7004
|
*/
|
|
7001
|
-
wallet_id
|
|
7005
|
+
wallet_id: string;
|
|
7002
7006
|
/** @description Optional, reserved for future use */
|
|
7003
7007
|
description?: string | null;
|
|
7008
|
+
/** Format: date-time */
|
|
7009
|
+
created_at: string;
|
|
7004
7010
|
} | null;
|
|
7005
7011
|
/** @description Payment destination linked to a counterparty account */
|
|
7006
7012
|
CounterpartyDestination: {
|
|
@@ -1413,6 +1413,80 @@ export interface paths {
|
|
|
1413
1413
|
};
|
|
1414
1414
|
trace?: never;
|
|
1415
1415
|
};
|
|
1416
|
+
"/frontend/counterparty/destinations/{id}/internal-transfer": {
|
|
1417
|
+
parameters: {
|
|
1418
|
+
query?: never;
|
|
1419
|
+
header?: never;
|
|
1420
|
+
path?: never;
|
|
1421
|
+
cookie?: never;
|
|
1422
|
+
};
|
|
1423
|
+
/**
|
|
1424
|
+
* Check internal-transfer availability for a destination
|
|
1425
|
+
* @description Read-only check (writes nothing). Resolves the destination's payment
|
|
1426
|
+
* details to an on-platform wallet within the tenant and reports whether an
|
|
1427
|
+
* instant internal transfer is available.
|
|
1428
|
+
*
|
|
1429
|
+
* A `true` answer means the caller can create an INTERNAL destination to
|
|
1430
|
+
* `target_wallet_id` and transfer to it. Any recipient that cannot receive
|
|
1431
|
+
* an instant internal transfer is uniformly reported as `available:false`
|
|
1432
|
+
* with `target_wallet_id:null` — the check does not disclose the reason.
|
|
1433
|
+
*
|
|
1434
|
+
* Detects crypto (address), INTERNAL (stored target wallet) and banking
|
|
1435
|
+
* (bank details matched against internal virtual accounts) destinations.
|
|
1436
|
+
*
|
|
1437
|
+
*/
|
|
1438
|
+
get: {
|
|
1439
|
+
parameters: {
|
|
1440
|
+
query?: never;
|
|
1441
|
+
header?: never;
|
|
1442
|
+
path: {
|
|
1443
|
+
id: string;
|
|
1444
|
+
};
|
|
1445
|
+
cookie?: never;
|
|
1446
|
+
};
|
|
1447
|
+
requestBody?: never;
|
|
1448
|
+
responses: {
|
|
1449
|
+
/** @description Internal-transfer availability for the destination */
|
|
1450
|
+
200: {
|
|
1451
|
+
headers: {
|
|
1452
|
+
[name: string]: unknown;
|
|
1453
|
+
};
|
|
1454
|
+
content: {
|
|
1455
|
+
"application/json": {
|
|
1456
|
+
/** @example true */
|
|
1457
|
+
success: boolean;
|
|
1458
|
+
data: components["schemas"]["InternalTransferAvailability"];
|
|
1459
|
+
};
|
|
1460
|
+
};
|
|
1461
|
+
};
|
|
1462
|
+
/** @description Access denied */
|
|
1463
|
+
403: {
|
|
1464
|
+
headers: {
|
|
1465
|
+
[name: string]: unknown;
|
|
1466
|
+
};
|
|
1467
|
+
content: {
|
|
1468
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1469
|
+
};
|
|
1470
|
+
};
|
|
1471
|
+
/** @description Not found */
|
|
1472
|
+
404: {
|
|
1473
|
+
headers: {
|
|
1474
|
+
[name: string]: unknown;
|
|
1475
|
+
};
|
|
1476
|
+
content: {
|
|
1477
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1478
|
+
};
|
|
1479
|
+
};
|
|
1480
|
+
};
|
|
1481
|
+
};
|
|
1482
|
+
put?: never;
|
|
1483
|
+
post?: never;
|
|
1484
|
+
delete?: never;
|
|
1485
|
+
options?: never;
|
|
1486
|
+
head?: never;
|
|
1487
|
+
patch?: never;
|
|
1488
|
+
trace?: never;
|
|
1489
|
+
};
|
|
1416
1490
|
"/frontend/counterparty/destinations": {
|
|
1417
1491
|
parameters: {
|
|
1418
1492
|
query?: never;
|
|
@@ -9896,7 +9970,7 @@ export interface components {
|
|
|
9896
9970
|
account_number?: string | null;
|
|
9897
9971
|
/** @description ABA routing number (9 digits) */
|
|
9898
9972
|
routing_number?: string | null;
|
|
9899
|
-
bank_name
|
|
9973
|
+
bank_name: string | null;
|
|
9900
9974
|
/** @description SWIFT/BIC (ISO 9362) */
|
|
9901
9975
|
swift_bic?: string | null;
|
|
9902
9976
|
/** @description IBAN (ISO 13616) */
|
|
@@ -9905,6 +9979,8 @@ export interface components {
|
|
|
9905
9979
|
sort_code?: string | null;
|
|
9906
9980
|
note?: string | null;
|
|
9907
9981
|
address?: components["schemas"]["CounterpartyBankingAddress"] | null;
|
|
9982
|
+
/** Format: date-time */
|
|
9983
|
+
created_at: string;
|
|
9908
9984
|
} | null;
|
|
9909
9985
|
/** @description Currency reference for a crypto destination (subset of the `crypto` table row). */
|
|
9910
9986
|
CounterpartyCurrencyRef: {
|
|
@@ -9919,12 +9995,14 @@ export interface components {
|
|
|
9919
9995
|
/** @description Crypto destination payload. Populated when `type` is CRYPTO_EXTERNAL or CRYPTO_INTERNAL; null otherwise. */
|
|
9920
9996
|
CounterpartyCryptoData: {
|
|
9921
9997
|
/** @description Blockchain address */
|
|
9922
|
-
address
|
|
9998
|
+
address: string;
|
|
9923
9999
|
/** @description Memo/tag (XRP, XLM, …) */
|
|
9924
10000
|
memo?: string | null;
|
|
9925
10001
|
/** Format: uuid */
|
|
9926
10002
|
currency_id?: string;
|
|
9927
|
-
currency
|
|
10003
|
+
currency: components["schemas"]["CounterpartyCurrencyRef"];
|
|
10004
|
+
/** Format: date-time */
|
|
10005
|
+
created_at: string;
|
|
9928
10006
|
} | null;
|
|
9929
10007
|
/** @description Internal destination payload — the receiver wallet on the same platform. Populated when `type` is INTERNAL; null otherwise. */
|
|
9930
10008
|
CounterpartyInternalData: {
|
|
@@ -9932,9 +10010,11 @@ export interface components {
|
|
|
9932
10010
|
* Format: uuid
|
|
9933
10011
|
* @description Target (receiver) wallet uuid
|
|
9934
10012
|
*/
|
|
9935
|
-
wallet_id
|
|
10013
|
+
wallet_id: string;
|
|
9936
10014
|
/** @description Optional, reserved for future use */
|
|
9937
10015
|
description?: string | null;
|
|
10016
|
+
/** Format: date-time */
|
|
10017
|
+
created_at: string;
|
|
9938
10018
|
} | null;
|
|
9939
10019
|
/** @description Counterparty payment destination. Exactly one of `banking_data` / `crypto_data` / `internal_data` is populated, matching `type`; the other two are null. */
|
|
9940
10020
|
CounterpartyDestination: {
|
|
@@ -9953,6 +10033,16 @@ export interface components {
|
|
|
9953
10033
|
crypto_data?: components["schemas"]["CounterpartyCryptoData"] | null;
|
|
9954
10034
|
internal_data?: components["schemas"]["CounterpartyInternalData"] | null;
|
|
9955
10035
|
};
|
|
10036
|
+
/** @description Whether an instant internal transfer is available for a counterparty destination. Two states: available (available=true, target_wallet_id set) and not available (available=false, target_wallet_id=null). Any recipient that cannot receive an instant internal transfer is uniformly reported as not available — the check does not disclose the reason. */
|
|
10037
|
+
InternalTransferAvailability: {
|
|
10038
|
+
/** @description True when the recipient is an on-platform wallet that can currently receive an instant internal transfer. */
|
|
10039
|
+
available: boolean;
|
|
10040
|
+
/**
|
|
10041
|
+
* Format: uuid
|
|
10042
|
+
* @description Wallet the transfer would go to — use it to create an INTERNAL destination. Present only when available=true; null otherwise.
|
|
10043
|
+
*/
|
|
10044
|
+
target_wallet_id: string | null;
|
|
10045
|
+
};
|
|
9956
10046
|
/** @description Bank / rail account coordinates for a sub-account. Rail-dependent — some rails return only a subset of these. */
|
|
9957
10047
|
BankAccountDetails: {
|
|
9958
10048
|
swift?: string;
|
|
@@ -7542,7 +7542,7 @@ export interface components {
|
|
|
7542
7542
|
id?: string;
|
|
7543
7543
|
account_number?: string | null;
|
|
7544
7544
|
routing_number?: string | null;
|
|
7545
|
-
bank_name
|
|
7545
|
+
bank_name: string | null;
|
|
7546
7546
|
swift_bic?: string | null;
|
|
7547
7547
|
iban?: string | null;
|
|
7548
7548
|
/** @description Sort code (6 digits, UK banking) */
|
|
@@ -7558,15 +7558,19 @@ export interface components {
|
|
|
7558
7558
|
street2?: string | null;
|
|
7559
7559
|
state_id?: number | null;
|
|
7560
7560
|
} | null;
|
|
7561
|
+
/** Format: date-time */
|
|
7562
|
+
created_at: string;
|
|
7561
7563
|
} | null;
|
|
7562
7564
|
CryptoData: {
|
|
7563
7565
|
/** Format: uuid */
|
|
7564
7566
|
id?: string;
|
|
7565
|
-
address
|
|
7567
|
+
address: string;
|
|
7566
7568
|
/** Format: uuid */
|
|
7567
7569
|
currency_id?: string;
|
|
7568
7570
|
memo?: string | null;
|
|
7569
|
-
currency
|
|
7571
|
+
currency: components["schemas"]["CurrencyRef"];
|
|
7572
|
+
/** Format: date-time */
|
|
7573
|
+
created_at: string;
|
|
7570
7574
|
} | null;
|
|
7571
7575
|
/** @description Internal destination payload — the receiver wallet on the same platform. Populated when type is INTERNAL; null otherwise. */
|
|
7572
7576
|
CounterpartyInternalData: {
|
|
@@ -7574,9 +7578,11 @@ export interface components {
|
|
|
7574
7578
|
* Format: uuid
|
|
7575
7579
|
* @description Target (receiver) wallet uuid
|
|
7576
7580
|
*/
|
|
7577
|
-
wallet_id
|
|
7581
|
+
wallet_id: string;
|
|
7578
7582
|
/** @description Optional, reserved for future use */
|
|
7579
7583
|
description?: string | null;
|
|
7584
|
+
/** Format: date-time */
|
|
7585
|
+
created_at: string;
|
|
7580
7586
|
} | null;
|
|
7581
7587
|
CounterpartyDestination: {
|
|
7582
7588
|
/** Format: uuid */
|
|
@@ -464,6 +464,12 @@ export declare namespace API {
|
|
|
464
464
|
};
|
|
465
465
|
type Response = Detail.DestinationDetailItem;
|
|
466
466
|
}
|
|
467
|
+
namespace InternalTransfer {
|
|
468
|
+
interface Request {
|
|
469
|
+
counterparty_destination_id: string;
|
|
470
|
+
}
|
|
471
|
+
type Response = componentsV1Frontend['schemas']['InternalTransferAvailability'];
|
|
472
|
+
}
|
|
467
473
|
}
|
|
468
474
|
namespace GetById {
|
|
469
475
|
interface Request {
|