@dakota-xyz/ts-sdk 1.1.0 → 1.3.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.d.mts +569 -17
- package/dist/index.d.ts +569 -17
- package/dist/index.js +119 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +119 -0
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -446,6 +446,13 @@ type components = {
|
|
|
446
446
|
readonly id: string;
|
|
447
447
|
/** @enum {string} */
|
|
448
448
|
readonly entry_type: "purchase" | "deduction" | "refund";
|
|
449
|
+
/**
|
|
450
|
+
* @description Sub-category that distinguishes transaction fees from compliance
|
|
451
|
+
* fees and similar for refunds. `unknown` indicates a legacy row
|
|
452
|
+
* written before this column existed.
|
|
453
|
+
* @enum {string}
|
|
454
|
+
*/
|
|
455
|
+
readonly category: "transaction_fee" | "compliance_fee" | "transaction_refund" | "compliance_refund" | "purchase" | "adjustment" | "unknown";
|
|
449
456
|
/**
|
|
450
457
|
* Format: int64
|
|
451
458
|
* @example -5000
|
|
@@ -457,6 +464,11 @@ type components = {
|
|
|
457
464
|
*/
|
|
458
465
|
readonly balance_after_cents: number;
|
|
459
466
|
readonly transaction_id?: string | null;
|
|
467
|
+
/**
|
|
468
|
+
* @description Stripe PaymentIntent ID (pi_...) for purchase entries — paste into the Stripe dashboard search to look up the underlying payment.
|
|
469
|
+
* @example pi_3M5xY42eZvKYlo2C0xRm6WVe
|
|
470
|
+
*/
|
|
471
|
+
readonly stripe_payment_intent_id?: string | null;
|
|
460
472
|
/** @example Transfer fee for transaction txn_123 */
|
|
461
473
|
readonly description: string;
|
|
462
474
|
/** Format: date-time */
|
|
@@ -517,6 +529,12 @@ type components = {
|
|
|
517
529
|
readonly role: components["schemas"]["ClientUserRole"];
|
|
518
530
|
/** @description Whether the client has SWIFT payments enabled. */
|
|
519
531
|
readonly swift_enabled?: boolean;
|
|
532
|
+
readonly client_id?: components["schemas"]["KSUID"];
|
|
533
|
+
/**
|
|
534
|
+
* @description Display name of the active client for this request.
|
|
535
|
+
* @example Acme Corp
|
|
536
|
+
*/
|
|
537
|
+
readonly client_name?: string;
|
|
520
538
|
/**
|
|
521
539
|
* @description Timestamp of when the user was created.
|
|
522
540
|
* @example 1234567890
|
|
@@ -529,6 +547,66 @@ type components = {
|
|
|
529
547
|
* @enum {string}
|
|
530
548
|
*/
|
|
531
549
|
readonly ClientUserRole: "admin" | "viewer";
|
|
550
|
+
readonly ClientPricingConfig: {
|
|
551
|
+
/**
|
|
552
|
+
* @description Monthly minimum fee in cents
|
|
553
|
+
* @example 10000
|
|
554
|
+
*/
|
|
555
|
+
readonly monthlyMinimumCents: number;
|
|
556
|
+
/**
|
|
557
|
+
* @description Transfer fee in basis points (0-10000, representing 0% to 100%)
|
|
558
|
+
* @example 25
|
|
559
|
+
*/
|
|
560
|
+
readonly transferFeeBps: number;
|
|
561
|
+
/**
|
|
562
|
+
* @description Per-ACH transaction fee in cents
|
|
563
|
+
* @example 100
|
|
564
|
+
*/
|
|
565
|
+
readonly achFeeCents: number;
|
|
566
|
+
/**
|
|
567
|
+
* @description Per-wire transaction fee in cents
|
|
568
|
+
* @example 2500
|
|
569
|
+
*/
|
|
570
|
+
readonly wireFeeCents: number;
|
|
571
|
+
/**
|
|
572
|
+
* @description Per-SEPA transaction fee in cents
|
|
573
|
+
* @example 150
|
|
574
|
+
*/
|
|
575
|
+
readonly sepaFeeCents: number;
|
|
576
|
+
/**
|
|
577
|
+
* @description Per-Swift-transfer banking fee in USD cents.
|
|
578
|
+
* @example 4000
|
|
579
|
+
*/
|
|
580
|
+
readonly swiftFeeCents: number;
|
|
581
|
+
/**
|
|
582
|
+
* @description Per-individual-application-submission compliance fee in USD cents.
|
|
583
|
+
* @example 500
|
|
584
|
+
*/
|
|
585
|
+
readonly kycFeeCents: number;
|
|
586
|
+
/**
|
|
587
|
+
* @description Per-business-application-submission compliance fee in USD cents.
|
|
588
|
+
* @example 2500
|
|
589
|
+
*/
|
|
590
|
+
readonly kybFeeCents: number;
|
|
591
|
+
/**
|
|
592
|
+
* Format: date-time
|
|
593
|
+
* @description When this pricing takes effect
|
|
594
|
+
* @example 2024-01-01T00:00:00Z
|
|
595
|
+
*/
|
|
596
|
+
readonly effectiveFrom: string;
|
|
597
|
+
/**
|
|
598
|
+
* Format: date-time
|
|
599
|
+
* @description When this pricing configuration was created
|
|
600
|
+
* @example 2024-01-01T00:00:00Z
|
|
601
|
+
*/
|
|
602
|
+
readonly createdAt: string;
|
|
603
|
+
/**
|
|
604
|
+
* Format: date-time
|
|
605
|
+
* @description When this pricing configuration was last updated
|
|
606
|
+
* @example 2024-01-01T00:00:00Z
|
|
607
|
+
*/
|
|
608
|
+
readonly updatedAt: string;
|
|
609
|
+
};
|
|
532
610
|
/** @description Request body for creating a new client user */
|
|
533
611
|
readonly CreateClientUserRequest: {
|
|
534
612
|
/**
|
|
@@ -665,7 +743,7 @@ type components = {
|
|
|
665
743
|
readonly idempotency_key?: string | null;
|
|
666
744
|
};
|
|
667
745
|
readonly EventData: {
|
|
668
|
-
/** @description Event resource snapshot after provider-field sanitization. */
|
|
746
|
+
/** @description Event resource snapshot after provider-field sanitization. The shape varies by event type; see the `GET /events` example responses for representative payloads. */
|
|
669
747
|
readonly object: {
|
|
670
748
|
readonly [key: string]: unknown;
|
|
671
749
|
};
|
|
@@ -795,6 +873,15 @@ type components = {
|
|
|
795
873
|
*/
|
|
796
874
|
readonly country: string;
|
|
797
875
|
};
|
|
876
|
+
/**
|
|
877
|
+
* Destination Address
|
|
878
|
+
* @description Address format for fiat destinations with Lead Bank wire transfer character limits (max 35 characters per address line).
|
|
879
|
+
*/
|
|
880
|
+
readonly FiatUSDestinationAddress: components["schemas"]["Address"] & {
|
|
881
|
+
readonly street1?: string;
|
|
882
|
+
readonly street2?: string;
|
|
883
|
+
readonly street3?: string;
|
|
884
|
+
};
|
|
798
885
|
readonly Country: {
|
|
799
886
|
/** @example CA */
|
|
800
887
|
readonly code: string;
|
|
@@ -862,12 +949,49 @@ type components = {
|
|
|
862
949
|
*/
|
|
863
950
|
readonly customer_type: "individual" | "business";
|
|
864
951
|
readonly kyb_status: components["schemas"]["KybStatus"];
|
|
952
|
+
/**
|
|
953
|
+
* @description Provider-agnostic effective KYC/B status for this customer,
|
|
954
|
+
* derived server-side for display convenience. Returns the same
|
|
955
|
+
* answer for both Sumsub-verified and Persona-verified customers
|
|
956
|
+
* without the client having to know which provider did the work.
|
|
957
|
+
*
|
|
958
|
+
* **Derivation order (most authoritative first):**
|
|
959
|
+
* 1. The customer's onboarding application `decision`, if set
|
|
960
|
+
* (`approved` → `approved`; `declined`/`auto_declined` →
|
|
961
|
+
* `rejected`; `withdrawn` → `expired`).
|
|
962
|
+
* 2. The most-recently-updated non-deleted persona `kyb_link`'s
|
|
963
|
+
* status (legacy customers from before the orchestration
|
|
964
|
+
* layer — Persona's `created` maps to `not_started`,
|
|
965
|
+
* `completed` to `approved`, `needs_review` to `in_review`).
|
|
966
|
+
* 3. `pending` if the customer has an open onboarding
|
|
967
|
+
* application but no decision yet (Sumsub in-flight).
|
|
968
|
+
* 4. `not_started` otherwise.
|
|
969
|
+
*
|
|
970
|
+
* **Advisory, not authoritative.** This field is provided for
|
|
971
|
+
* badge rendering and operator UIs. The derivation rules may
|
|
972
|
+
* evolve as new verification providers are added. For
|
|
973
|
+
* compliance-critical decisions, consult `decision`,
|
|
974
|
+
* `kyb_links`, and `provider_statuses` directly.
|
|
975
|
+
*/
|
|
976
|
+
readonly kyc_status: components["schemas"]["KybLinkStatus"];
|
|
865
977
|
/** @description KYB Links for different providers used in the KYB process. */
|
|
866
978
|
readonly kyb_links?: readonly components["schemas"]["KybLink"][];
|
|
867
979
|
/** @description Detailed status information from different verification providers used in the KYB process. */
|
|
868
980
|
readonly provider_statuses?: readonly components["schemas"]["ProviderKybStatus"][];
|
|
869
981
|
/** @description ID of the KYB application associated with this customer */
|
|
870
982
|
readonly application_id?: components["schemas"]["KSUID"];
|
|
983
|
+
/**
|
|
984
|
+
* @description Current lifecycle state of the customer's onboarding application
|
|
985
|
+
* (e.g. `pending`, `submitted`, `under_review`, `approved`,
|
|
986
|
+
* `declined`). Omitted when the customer has no application.
|
|
987
|
+
*
|
|
988
|
+
* Use this field to drive workflow UI — it tracks where the
|
|
989
|
+
* customer is in the onboarding flow. For the orthogonal questions
|
|
990
|
+
* "is this customer cleared to transact?" and "what's the
|
|
991
|
+
* provider-agnostic KYC verdict?", see `kyb_status` and
|
|
992
|
+
* `kyc_status` respectively.
|
|
993
|
+
*/
|
|
994
|
+
readonly application_status?: components["schemas"]["ApplicationStatus"];
|
|
871
995
|
/**
|
|
872
996
|
* @description Application decision status
|
|
873
997
|
* @example approved
|
|
@@ -988,6 +1112,13 @@ type components = {
|
|
|
988
1112
|
/**
|
|
989
1113
|
* KYB Link Type
|
|
990
1114
|
* @description Type of link provided by a verification provider for KYB verification.
|
|
1115
|
+
*
|
|
1116
|
+
* **Deprecated values:**
|
|
1117
|
+
* - `tos` — the Bridge TOS flow has been deprecated. The dashboard no
|
|
1118
|
+
* longer surfaces TOS state, but legacy customer records may still
|
|
1119
|
+
* carry `link_type: 'tos'` entries on the wire. New integrations
|
|
1120
|
+
* should ignore these entries; the value is retained in the enum
|
|
1121
|
+
* to keep responses for legacy data schema-valid.
|
|
991
1122
|
* @example persona
|
|
992
1123
|
* @enum {string}
|
|
993
1124
|
*/
|
|
@@ -1012,10 +1143,15 @@ type components = {
|
|
|
1012
1143
|
* - `approved` - Application approved
|
|
1013
1144
|
* - `declined` - Application declined
|
|
1014
1145
|
* - `completed` - Legacy status (deprecated, use approved/declined instead)
|
|
1146
|
+
* - `compliance_review` - Application is awaiting compliance review of a Proof of Address
|
|
1147
|
+
* document. Set when an individual applicant uploads a PoA-equivalent document
|
|
1148
|
+
* (proof_of_address, bank_statement, or utility_bill) after their application has
|
|
1149
|
+
* already been approved or completed. The customer remains active but is subject to
|
|
1150
|
+
* the $3,000 USD-equivalent rolling 7-day transaction limit until the review concludes.
|
|
1015
1151
|
* @example submitted
|
|
1016
1152
|
* @enum {string}
|
|
1017
1153
|
*/
|
|
1018
|
-
readonly ApplicationStatus: "pending" | "submitted" | "under_review" | "request_for_information" | "admin_revision" | "approved" | "declined" | "completed";
|
|
1154
|
+
readonly ApplicationStatus: "pending" | "submitted" | "under_review" | "request_for_information" | "admin_revision" | "approved" | "declined" | "completed" | "compliance_review";
|
|
1019
1155
|
/**
|
|
1020
1156
|
* Family
|
|
1021
1157
|
* @description Blockchain family for the crypto account.
|
|
@@ -1035,7 +1171,7 @@ type components = {
|
|
|
1035
1171
|
* @description Current status of a transaction.
|
|
1036
1172
|
* @enum {string}
|
|
1037
1173
|
*/
|
|
1038
|
-
readonly TransactionStatus: "timed_out" | "not_started" | "in_progress" | "awaiting_confirmation" | "pending" | "processing" | "completed" | "invalid" | "failed" | "canceled" | "reversed" | "rejected" | "broadcasted" | "pending_return" | "returned";
|
|
1174
|
+
readonly TransactionStatus: "timed_out" | "not_started" | "in_progress" | "awaiting_confirmation" | "pending" | "processing" | "completed" | "invalid" | "failed" | "canceled" | "reversed" | "rejected" | "broadcasted" | "pending_return" | "returned" | "pending_reversal";
|
|
1039
1175
|
/**
|
|
1040
1176
|
* Transaction Type
|
|
1041
1177
|
* @description Type of transaction.
|
|
@@ -1286,13 +1422,13 @@ type components = {
|
|
|
1286
1422
|
readonly account_type: "checking" | "savings";
|
|
1287
1423
|
/** @example John Doe */
|
|
1288
1424
|
readonly account_holder_name: string;
|
|
1289
|
-
readonly account_holder_address?: components["schemas"]["
|
|
1425
|
+
readonly account_holder_address?: components["schemas"]["FiatUSDestinationAddress"];
|
|
1290
1426
|
/** @example 1234567890 */
|
|
1291
1427
|
readonly account_holder_phone?: string;
|
|
1292
1428
|
/** @example Bank of America */
|
|
1293
1429
|
readonly bank_name: string;
|
|
1294
1430
|
/** @description Address of the bank. Optional for US domestic transfers. */
|
|
1295
|
-
readonly bank_address?: components["schemas"]["
|
|
1431
|
+
readonly bank_address?: components["schemas"]["FiatUSDestinationAddress"];
|
|
1296
1432
|
/** @example 1234567890 */
|
|
1297
1433
|
readonly bank_phone?: string;
|
|
1298
1434
|
} & {
|
|
@@ -1631,6 +1767,7 @@ type components = {
|
|
|
1631
1767
|
* @example 1234567890
|
|
1632
1768
|
*/
|
|
1633
1769
|
readonly completedAt?: number | null;
|
|
1770
|
+
readonly sender_details?: components["schemas"]["SenderDetails"];
|
|
1634
1771
|
};
|
|
1635
1772
|
readonly TransactionResource: components["schemas"]["OneOffTransaction"] | components["schemas"]["WalletTransaction"] | components["schemas"]["Transaction"];
|
|
1636
1773
|
readonly PaginatedCustomerTransactionResponse: components["schemas"]["PaginatedListResponse"] & {
|
|
@@ -1794,6 +1931,64 @@ type components = {
|
|
|
1794
1931
|
/** @description List of event types this target cares about (ignored if global is true) */
|
|
1795
1932
|
readonly event_types?: readonly components["schemas"]["EventType"][];
|
|
1796
1933
|
};
|
|
1934
|
+
/** @description Originating sender details for onramp/offramp/swap transactions. Populated when source-side metadata is available (e.g., from inbound wire/ACH source data). */
|
|
1935
|
+
readonly SenderDetails: {
|
|
1936
|
+
/**
|
|
1937
|
+
* @description Type of the originating sender (e.g., "fiat_account", "crypto_wallet").
|
|
1938
|
+
* @example fiat_account
|
|
1939
|
+
*/
|
|
1940
|
+
readonly sender_type?: string;
|
|
1941
|
+
/**
|
|
1942
|
+
* @description Name on the originating account.
|
|
1943
|
+
* @example John Doe
|
|
1944
|
+
*/
|
|
1945
|
+
readonly sender_account_holder_name?: string;
|
|
1946
|
+
/**
|
|
1947
|
+
* @description Bank name of the originating account.
|
|
1948
|
+
* @example Chase Bank
|
|
1949
|
+
*/
|
|
1950
|
+
readonly sender_bank_name?: string;
|
|
1951
|
+
/**
|
|
1952
|
+
* @description ACH routing number of the originating bank account.
|
|
1953
|
+
* @example 021000021
|
|
1954
|
+
*/
|
|
1955
|
+
readonly sender_routing_number?: string;
|
|
1956
|
+
/**
|
|
1957
|
+
* @description Account number of the originating bank account.
|
|
1958
|
+
* @example 1234567890
|
|
1959
|
+
*/
|
|
1960
|
+
readonly sender_account_number?: string;
|
|
1961
|
+
/**
|
|
1962
|
+
* @description Wire routing number of the originating bank account.
|
|
1963
|
+
* @example 021000021
|
|
1964
|
+
*/
|
|
1965
|
+
readonly sender_wire_routing_number?: string;
|
|
1966
|
+
/**
|
|
1967
|
+
* @description Type of the originating bank account (e.g., "checking", "savings").
|
|
1968
|
+
* @example checking
|
|
1969
|
+
*/
|
|
1970
|
+
readonly sender_account_type?: string;
|
|
1971
|
+
/**
|
|
1972
|
+
* @description IBAN of the originating account.
|
|
1973
|
+
* @example GB82WEST12345698765432
|
|
1974
|
+
*/
|
|
1975
|
+
readonly sender_iban?: string;
|
|
1976
|
+
/**
|
|
1977
|
+
* @description BIC/SWIFT code of the originating bank.
|
|
1978
|
+
* @example BARCGB22XXX
|
|
1979
|
+
*/
|
|
1980
|
+
readonly sender_bic?: string;
|
|
1981
|
+
/**
|
|
1982
|
+
* @description Blockchain wallet address of the originating sender (offramp/swap).
|
|
1983
|
+
* @example 0x1234567890abcdef1234567890abcdef12345678
|
|
1984
|
+
*/
|
|
1985
|
+
readonly sender_wallet_address?: string;
|
|
1986
|
+
/**
|
|
1987
|
+
* @description Network identifier of the originating wallet (e.g., "ethereum-mainnet").
|
|
1988
|
+
* @example ethereum-mainnet
|
|
1989
|
+
*/
|
|
1990
|
+
readonly sender_network?: string;
|
|
1991
|
+
};
|
|
1797
1992
|
/** @description A transaction relating to an auto account */
|
|
1798
1993
|
readonly AutoAccountTransaction: {
|
|
1799
1994
|
readonly id: components["schemas"]["KSUID"];
|
|
@@ -1821,6 +2016,7 @@ type components = {
|
|
|
1821
2016
|
readonly completed_at?: number;
|
|
1822
2017
|
readonly receipt?: components["schemas"]["TransactionReceipt"];
|
|
1823
2018
|
readonly crypto_details?: components["schemas"]["TransactionCryptoDetails"];
|
|
2019
|
+
readonly sender_details?: components["schemas"]["SenderDetails"];
|
|
1824
2020
|
/**
|
|
1825
2021
|
* @description Provider identifier
|
|
1826
2022
|
* @example dakota
|
|
@@ -1836,6 +2032,36 @@ type components = {
|
|
|
1836
2032
|
* @example processing
|
|
1837
2033
|
*/
|
|
1838
2034
|
readonly provider_status: string;
|
|
2035
|
+
/**
|
|
2036
|
+
* @description NACHA/Fedwire return code (e.g., R01) when the transaction was returned by the receiving bank.
|
|
2037
|
+
* @example R01
|
|
2038
|
+
*/
|
|
2039
|
+
readonly return_code?: string;
|
|
2040
|
+
/**
|
|
2041
|
+
* @description Human-readable return reason provided by the receiving bank.
|
|
2042
|
+
* @example Insufficient Funds
|
|
2043
|
+
*/
|
|
2044
|
+
readonly return_reason?: string;
|
|
2045
|
+
/**
|
|
2046
|
+
* @description Unix timestamp when the return was initiated.
|
|
2047
|
+
* @example 1234567890
|
|
2048
|
+
*/
|
|
2049
|
+
readonly return_initiated_at?: number;
|
|
2050
|
+
/**
|
|
2051
|
+
* @description Unix timestamp deadline for return processing.
|
|
2052
|
+
* @example 1234567890
|
|
2053
|
+
*/
|
|
2054
|
+
readonly return_deadline?: number;
|
|
2055
|
+
/**
|
|
2056
|
+
* @description Lead Bank ACH reversal reason when the originator reverses the transaction (e.g., duplicate, receiver_incorrect).
|
|
2057
|
+
* @example duplicate
|
|
2058
|
+
*/
|
|
2059
|
+
readonly reversal_reason?: string;
|
|
2060
|
+
/**
|
|
2061
|
+
* @description Unix timestamp when the reversal was initiated.
|
|
2062
|
+
* @example 1234567890
|
|
2063
|
+
*/
|
|
2064
|
+
readonly reversal_initiated_at?: number;
|
|
1839
2065
|
};
|
|
1840
2066
|
/** @description Detailed representation of an amount with its asset and optional metadata */
|
|
1841
2067
|
readonly AmountDetails: {
|
|
@@ -1892,20 +2118,59 @@ type components = {
|
|
|
1892
2118
|
readonly PaginatedAutoTransactionResponse: components["schemas"]["PaginatedListResponse"] & {
|
|
1893
2119
|
readonly data?: readonly components["schemas"]["AutoAccountTransaction"][];
|
|
1894
2120
|
};
|
|
2121
|
+
/** @description Slim reference to a policy attached to a wallet (id + name only). */
|
|
2122
|
+
readonly AttachedPolicy: {
|
|
2123
|
+
/**
|
|
2124
|
+
* @description Policy id.
|
|
2125
|
+
* @example pol_2N4YkKpKu7M3mKpGYmF8kcJ8oZT
|
|
2126
|
+
*/
|
|
2127
|
+
readonly id: string;
|
|
2128
|
+
/**
|
|
2129
|
+
* @description Policy name.
|
|
2130
|
+
* @example High Value Transaction Policy
|
|
2131
|
+
*/
|
|
2132
|
+
readonly name: string;
|
|
2133
|
+
};
|
|
2134
|
+
/** @description Slim reference to a wallet attached to a policy or signer group (id + name + family). */
|
|
2135
|
+
readonly AttachedWallet: {
|
|
2136
|
+
readonly id: components["schemas"]["KSUID"];
|
|
2137
|
+
/**
|
|
2138
|
+
* @description Wallet name.
|
|
2139
|
+
* @example Treasury Wallet
|
|
2140
|
+
*/
|
|
2141
|
+
readonly name: string;
|
|
2142
|
+
readonly family: components["schemas"]["Family"];
|
|
2143
|
+
};
|
|
1895
2144
|
/**
|
|
1896
2145
|
* @description Transaction type for one-off transaction creation.
|
|
1897
2146
|
* @example one_off
|
|
1898
2147
|
* @enum {string}
|
|
1899
2148
|
*/
|
|
1900
2149
|
readonly OneOffTransactionType: "one_off";
|
|
1901
|
-
/**
|
|
2150
|
+
/**
|
|
2151
|
+
* @description Request to create a one-off transfer. The transfer type is determined by
|
|
2152
|
+
* the destination type referenced by `destination_id`:
|
|
2153
|
+
* - **Offramp** when the destination is a fiat bank account (fiat_us or
|
|
2154
|
+
* fiat_iban). `destination_payment_rail` is honored; `destination_network_id`
|
|
2155
|
+
* is ignored.
|
|
2156
|
+
* - **Swap** when the destination is a crypto address.
|
|
2157
|
+
* `destination_network_id` is required and selects the destination
|
|
2158
|
+
* chain.
|
|
2159
|
+
*
|
|
2160
|
+
* The platform generates a single-use deposit address and finalizes the
|
|
2161
|
+
* transfer once the source-asset deposit arrives.
|
|
2162
|
+
*/
|
|
1902
2163
|
readonly OneOffTransactionRequest: {
|
|
1903
2164
|
readonly transaction_type?: components["schemas"]["OneOffTransactionType"];
|
|
1904
2165
|
/**
|
|
1905
|
-
* @description
|
|
2166
|
+
* @description Optional expected destination amount as a decimal string. When
|
|
2167
|
+
* omitted, the resulting transaction's destination amount is
|
|
2168
|
+
* populated from the actual deposit once funds arrive. When
|
|
2169
|
+
* provided, must be at least 0.01 and is enforced by sandbox
|
|
2170
|
+
* amount caps where applicable.
|
|
1906
2171
|
* @example 1.23
|
|
1907
2172
|
*/
|
|
1908
|
-
readonly amount
|
|
2173
|
+
readonly amount?: string;
|
|
1909
2174
|
readonly customer_id: components["schemas"]["KSUID"];
|
|
1910
2175
|
readonly source_network_id: components["schemas"]["NetworkId"];
|
|
1911
2176
|
/**
|
|
@@ -1916,11 +2181,11 @@ type components = {
|
|
|
1916
2181
|
readonly destination_id: components["schemas"]["KSUID"];
|
|
1917
2182
|
readonly destination_network_id?: components["schemas"]["NetworkId"];
|
|
1918
2183
|
/**
|
|
1919
|
-
* @description Destination fiat currency
|
|
2184
|
+
* @description Destination asset symbol. For offramps this is a fiat currency (e.g. `USD`, `EUR`). For swaps this is the destination stablecoin (e.g. `USDC`, `DKUSD`).
|
|
1920
2185
|
* @example USD
|
|
1921
2186
|
*/
|
|
1922
2187
|
readonly destination_asset: string;
|
|
1923
|
-
/** @description Optional preferred payment rail for bank transfers. If not specified, the system will automatically select the most appropriate rail based on the destination's supported methods. */
|
|
2188
|
+
/** @description Optional preferred payment rail for bank transfers (offramp). Ignored when the destination is a crypto address. If not specified, the system will automatically select the most appropriate rail based on the destination's supported methods. */
|
|
1924
2189
|
readonly destination_payment_rail?: components["schemas"]["PaymentCapability"];
|
|
1925
2190
|
/**
|
|
1926
2191
|
* @description Optional payment reference message for bank transfers. Length limits: ACH (1-10 chars), Wire (1-140 chars), SEPA (6-140 chars), SWIFT (1-140 chars, max 4 lines of 35 chars each)
|
|
@@ -1934,7 +2199,7 @@ type components = {
|
|
|
1934
2199
|
*/
|
|
1935
2200
|
readonly developer_fee_bps?: number;
|
|
1936
2201
|
};
|
|
1937
|
-
/** @description A one-off transaction response. Used for single
|
|
2202
|
+
/** @description A one-off transaction response. Used for single-use offramp (crypto-to-fiat) and swap (crypto-to-crypto) transfers; the destination type determines which. */
|
|
1938
2203
|
readonly OneOffTransaction: {
|
|
1939
2204
|
readonly id: components["schemas"]["KSUID"];
|
|
1940
2205
|
/**
|
|
@@ -1971,6 +2236,7 @@ type components = {
|
|
|
1971
2236
|
readonly failure_reason?: string;
|
|
1972
2237
|
readonly receipt?: components["schemas"]["TransactionReceipt"];
|
|
1973
2238
|
readonly crypto_details?: components["schemas"]["TransactionCryptoDetails"];
|
|
2239
|
+
readonly sender_details?: components["schemas"]["SenderDetails"];
|
|
1974
2240
|
/**
|
|
1975
2241
|
* @description Unix timestamp when the transaction was created
|
|
1976
2242
|
* @example 1234567890
|
|
@@ -2020,13 +2286,48 @@ type components = {
|
|
|
2020
2286
|
* @example BARCGB22XXX
|
|
2021
2287
|
*/
|
|
2022
2288
|
readonly destination_bic?: string;
|
|
2289
|
+
/**
|
|
2290
|
+
* @description NACHA/Fedwire return code (e.g., R01) when the transaction was returned by the receiving bank.
|
|
2291
|
+
* @example R01
|
|
2292
|
+
*/
|
|
2293
|
+
readonly return_code?: string;
|
|
2294
|
+
/**
|
|
2295
|
+
* @description Human-readable return reason provided by the receiving bank.
|
|
2296
|
+
* @example Insufficient Funds
|
|
2297
|
+
*/
|
|
2298
|
+
readonly return_reason?: string;
|
|
2299
|
+
/**
|
|
2300
|
+
* @description Unix timestamp when the return was initiated.
|
|
2301
|
+
* @example 1234567890
|
|
2302
|
+
*/
|
|
2303
|
+
readonly return_initiated_at?: number;
|
|
2304
|
+
/**
|
|
2305
|
+
* @description Unix timestamp deadline for return processing.
|
|
2306
|
+
* @example 1234567890
|
|
2307
|
+
*/
|
|
2308
|
+
readonly return_deadline?: number;
|
|
2309
|
+
/**
|
|
2310
|
+
* @description Lead Bank ACH reversal reason when the originator reverses the transaction (e.g., duplicate, receiver_incorrect).
|
|
2311
|
+
* @example duplicate
|
|
2312
|
+
*/
|
|
2313
|
+
readonly reversal_reason?: string;
|
|
2314
|
+
/**
|
|
2315
|
+
* @description Unix timestamp when the reversal was initiated.
|
|
2316
|
+
* @example 1234567890
|
|
2317
|
+
*/
|
|
2318
|
+
readonly reversal_initiated_at?: number;
|
|
2319
|
+
/**
|
|
2320
|
+
* @description Display name of the customer associated with this transaction.
|
|
2321
|
+
* @example Acme Corp
|
|
2322
|
+
*/
|
|
2323
|
+
readonly customer_name?: string;
|
|
2023
2324
|
};
|
|
2024
2325
|
/**
|
|
2025
2326
|
* @description Status of a one-off transaction
|
|
2026
2327
|
* @example pending
|
|
2027
2328
|
* @enum {string}
|
|
2028
2329
|
*/
|
|
2029
|
-
readonly OneOffTransactionStatus: "pending" | "processing" | "completed" | "failed" | "cancelled" | "reversed" | "pending_return" | "returned";
|
|
2330
|
+
readonly OneOffTransactionStatus: "pending" | "processing" | "completed" | "failed" | "cancelled" | "reversed" | "pending_return" | "returned" | "pending_reversal";
|
|
2030
2331
|
readonly PaginatedOneOffTransactionResponse: components["schemas"]["PaginatedListResponse"] & {
|
|
2031
2332
|
readonly data?: readonly components["schemas"]["OneOffTransaction"][];
|
|
2032
2333
|
};
|
|
@@ -2035,6 +2336,8 @@ type components = {
|
|
|
2035
2336
|
readonly id: components["schemas"]["KSUID"];
|
|
2036
2337
|
readonly client_id: components["schemas"]["KSUID"];
|
|
2037
2338
|
readonly customer_id?: components["schemas"]["KSUID"];
|
|
2339
|
+
/** @description Customer name joined server-side. Populated on GET responses; omitted from create responses. */
|
|
2340
|
+
readonly customer_name?: string | null;
|
|
2038
2341
|
readonly family: components["schemas"]["Family"];
|
|
2039
2342
|
/**
|
|
2040
2343
|
* @description The wallet address, same across all networks within the same family
|
|
@@ -2046,6 +2349,8 @@ type components = {
|
|
|
2046
2349
|
* @example My Wallet
|
|
2047
2350
|
*/
|
|
2048
2351
|
readonly name: string;
|
|
2352
|
+
/** @description Created-at unix timestamp. Populated on GET responses. */
|
|
2353
|
+
readonly created_at?: number;
|
|
2049
2354
|
};
|
|
2050
2355
|
/** @description Request to create a new non-custodial wallet */
|
|
2051
2356
|
readonly WalletCreateRequest: {
|
|
@@ -2137,7 +2442,13 @@ type components = {
|
|
|
2137
2442
|
* @example Marc
|
|
2138
2443
|
*/
|
|
2139
2444
|
readonly name: string;
|
|
2140
|
-
/**
|
|
2445
|
+
/**
|
|
2446
|
+
* @description The signer public key. For KEY_TYPE_ES256 this must be a
|
|
2447
|
+
* base64-encoded X.509 SubjectPublicKeyInfo (PKIX) for an ECDSA
|
|
2448
|
+
* P-256 key. Both PEM-wrapped (with BEGIN/END PUBLIC KEY headers)
|
|
2449
|
+
* and raw DER encodings are accepted. For KEY_TYPE_WEBAUTHN this
|
|
2450
|
+
* must be a base64-encoded COSE public key.
|
|
2451
|
+
*/
|
|
2141
2452
|
readonly public_key: string;
|
|
2142
2453
|
/**
|
|
2143
2454
|
* @description Type of the key
|
|
@@ -2152,7 +2463,13 @@ type components = {
|
|
|
2152
2463
|
* @example Marc
|
|
2153
2464
|
*/
|
|
2154
2465
|
readonly name: string;
|
|
2155
|
-
/**
|
|
2466
|
+
/**
|
|
2467
|
+
* @description The signer public key. For KEY_TYPE_ES256 this must be a
|
|
2468
|
+
* base64-encoded X.509 SubjectPublicKeyInfo (PKIX) for an ECDSA
|
|
2469
|
+
* P-256 key. Both PEM-wrapped (with BEGIN/END PUBLIC KEY headers)
|
|
2470
|
+
* and raw DER encodings are accepted. For KEY_TYPE_WEBAUTHN this
|
|
2471
|
+
* must be a base64-encoded COSE public key.
|
|
2472
|
+
*/
|
|
2156
2473
|
readonly public_key: string;
|
|
2157
2474
|
/**
|
|
2158
2475
|
* @description Type of the key
|
|
@@ -2174,6 +2491,11 @@ type components = {
|
|
|
2174
2491
|
*/
|
|
2175
2492
|
readonly id: string;
|
|
2176
2493
|
readonly client_id?: components["schemas"]["KSUID"];
|
|
2494
|
+
/**
|
|
2495
|
+
* @description ID of the signer group that governs mutations of this policy. Members of this group must endorse any add_policy_rule, update_policy_rule, remove_policy_rule, or delete_policy intent.
|
|
2496
|
+
* @example grp_2N4YkKpKu7M3mKpGYmF8kcJ8oZT
|
|
2497
|
+
*/
|
|
2498
|
+
readonly signer_group_id?: string | null;
|
|
2177
2499
|
/**
|
|
2178
2500
|
* Format: int32
|
|
2179
2501
|
* @description Version number of the policy (incremented on rule changes)
|
|
@@ -2295,6 +2617,21 @@ type components = {
|
|
|
2295
2617
|
readonly operation: components["schemas"]["TransactionOperation"];
|
|
2296
2618
|
/** @description A unique key to ensure idempotency of the request */
|
|
2297
2619
|
readonly idempotency_key: string;
|
|
2620
|
+
/**
|
|
2621
|
+
* @description Optional opaque SHA-256d digest (base64-encoded) of an upstream
|
|
2622
|
+
* operator-meaningful context envelope produced by the originating
|
|
2623
|
+
* service (e.g. financial-account).
|
|
2624
|
+
*
|
|
2625
|
+
* Neither platform nor policy-engine interprets the semantic
|
|
2626
|
+
* content. Policy-engine includes the field in canonical hashing
|
|
2627
|
+
* so the WebAuthn signature commits to it; beyond that the digest
|
|
2628
|
+
* is never read, validated, or logged. The pre-image is persisted
|
|
2629
|
+
* upstream and exists for forensic / non-repudiation purposes
|
|
2630
|
+
* (see ENG-1962).
|
|
2631
|
+
*
|
|
2632
|
+
* Intents predating this field validate as today (empty / omitted).
|
|
2633
|
+
*/
|
|
2634
|
+
readonly context_digest?: string;
|
|
2298
2635
|
};
|
|
2299
2636
|
readonly TransactionOperation: {
|
|
2300
2637
|
/** @description Transaction type: transfer or contract call */
|
|
@@ -2303,7 +2640,12 @@ type components = {
|
|
|
2303
2640
|
readonly from: string;
|
|
2304
2641
|
/** @description The recipient address of the transaction */
|
|
2305
2642
|
readonly to: string;
|
|
2306
|
-
/**
|
|
2643
|
+
/**
|
|
2644
|
+
* @description Amount to be transferred as a non-negative decimal string. Required for
|
|
2645
|
+
* transfer operations; optional for contract calls (defaults to zero).
|
|
2646
|
+
* Leading zeros, signs, commas, and non-finite values are rejected.
|
|
2647
|
+
* For transfer operations the handler additionally requires the value to be greater than zero.
|
|
2648
|
+
*/
|
|
2307
2649
|
readonly amount?: string;
|
|
2308
2650
|
/**
|
|
2309
2651
|
* @description Crypto asset symbol for the transfer or contract call.
|
|
@@ -2911,7 +3253,7 @@ type components = {
|
|
|
2911
3253
|
*/
|
|
2912
3254
|
readonly uploaded_at: string;
|
|
2913
3255
|
};
|
|
2914
|
-
/** @description Information about a
|
|
3256
|
+
/** @description Information about a missing document the applicant has not yet uploaded. Includes both required documents (whose absence blocks readiness) and optional ones (e.g. Proof of Address for individuals when the PoA-optional flow is enabled — surfaced so the UI can render an upload affordance without gating submission). */
|
|
2915
3257
|
readonly MissingDocument: {
|
|
2916
3258
|
/**
|
|
2917
3259
|
* @description The purpose this document serves in the onboarding requirements
|
|
@@ -2931,6 +3273,11 @@ type components = {
|
|
|
2931
3273
|
* @example Articles of Incorporation or equivalent formation document
|
|
2932
3274
|
*/
|
|
2933
3275
|
readonly description: string;
|
|
3276
|
+
/**
|
|
3277
|
+
* @description Whether this document must be uploaded for the application to be ready for review. When false, the document is optional — typically because an alternative gating mechanism applies (e.g. the post-onboarding $3,000 / 7-day rolling-window threshold for Proof of Address on individual applications under the PoA-optional flow).
|
|
3278
|
+
* @example true
|
|
3279
|
+
*/
|
|
3280
|
+
readonly required?: boolean;
|
|
2934
3281
|
};
|
|
2935
3282
|
/** @description Document status information for an applicant entity */
|
|
2936
3283
|
readonly DocumentInfo: {
|
|
@@ -3681,6 +4028,17 @@ type components = {
|
|
|
3681
4028
|
* @enum {string|null}
|
|
3682
4029
|
*/
|
|
3683
4030
|
readonly application_decision?: "approved" | "declined" | "withdrawn" | null;
|
|
4031
|
+
/**
|
|
4032
|
+
* @description How the decision was reached: 'manual' for operator-driven decisions, 'auto' for automated approvals, 'override' reserved for future escalation. Null if no decision has been made.
|
|
4033
|
+
* @example manual
|
|
4034
|
+
* @enum {string|null}
|
|
4035
|
+
*/
|
|
4036
|
+
readonly decision_method?: "manual" | "auto" | "override" | null;
|
|
4037
|
+
/**
|
|
4038
|
+
* @description Version identifier of the rule set that produced an automated decision. Null for manual decisions or when no decision has been made.
|
|
4039
|
+
* @example v1.2
|
|
4040
|
+
*/
|
|
4041
|
+
readonly decision_rule_version?: string | null;
|
|
3684
4042
|
/** @description The people/businesses being onboarded */
|
|
3685
4043
|
readonly entities?: components["schemas"]["ApplicationEntities"];
|
|
3686
4044
|
/** @description Enhanced Due Diligence data (if provided) */
|
|
@@ -3691,6 +4049,24 @@ type components = {
|
|
|
3691
4049
|
readonly validation?: components["schemas"]["ApplicationValidation"];
|
|
3692
4050
|
/** @description Risk rating (only present for superadmin users) */
|
|
3693
4051
|
readonly risk_rating?: components["schemas"]["RiskRating"];
|
|
4052
|
+
/**
|
|
4053
|
+
* @description Tracks the review state of the Proof of Address for individual applications.
|
|
4054
|
+
* Null for business applications and for non-primary-individual rows.
|
|
4055
|
+
*
|
|
4056
|
+
* - `missing` — No Proof of Address has been submitted. The individual is subject
|
|
4057
|
+
* to the $3,000 USD-equivalent rolling 7-day transaction limit.
|
|
4058
|
+
* - `submitted_pending_review` — A PoA-equivalent document (proof_of_address,
|
|
4059
|
+
* bank_statement, or utility_bill) has been uploaded and is awaiting compliance
|
|
4060
|
+
* review. The individual remains subject to the transaction limit until the review
|
|
4061
|
+
* concludes.
|
|
4062
|
+
* - `approved` — The Proof of Address has been reviewed and approved. The individual
|
|
4063
|
+
* is exempt from the $3,000 / 7-day rolling transaction threshold.
|
|
4064
|
+
* - `rejected` — The submitted Proof of Address was rejected. The individual
|
|
4065
|
+
* remains subject to the transaction limit and may re-upload a new document.
|
|
4066
|
+
* @example missing
|
|
4067
|
+
* @enum {string|null}
|
|
4068
|
+
*/
|
|
4069
|
+
readonly poa_status?: "missing" | "submitted_pending_review" | "approved" | "rejected" | null;
|
|
3694
4070
|
};
|
|
3695
4071
|
/** @description Lightweight business info for list views */
|
|
3696
4072
|
readonly BusinessListItem: {
|
|
@@ -3907,6 +4283,32 @@ type components = {
|
|
|
3907
4283
|
*/
|
|
3908
4284
|
readonly applicant_id: string;
|
|
3909
4285
|
};
|
|
4286
|
+
/** @description Error response when a self-serve client lacks the credits required to perform an action. */
|
|
4287
|
+
readonly InsufficientCreditsError: {
|
|
4288
|
+
/**
|
|
4289
|
+
* @description Stable machine-readable error code.
|
|
4290
|
+
* @example insufficient_credits
|
|
4291
|
+
* @enum {string}
|
|
4292
|
+
*/
|
|
4293
|
+
readonly error: "insufficient_credits";
|
|
4294
|
+
/**
|
|
4295
|
+
* @description Human-readable explanation including the required and current amounts.
|
|
4296
|
+
* @example Insufficient credits to submit this application. Required 2500 cents, balance 500 cents.
|
|
4297
|
+
*/
|
|
4298
|
+
readonly message: string;
|
|
4299
|
+
/**
|
|
4300
|
+
* Format: int64
|
|
4301
|
+
* @description Amount of credits required to perform this action, in USD cents.
|
|
4302
|
+
* @example 2500
|
|
4303
|
+
*/
|
|
4304
|
+
readonly required_cents: number;
|
|
4305
|
+
/**
|
|
4306
|
+
* Format: int64
|
|
4307
|
+
* @description Caller's current credit balance, in USD cents.
|
|
4308
|
+
* @example 500
|
|
4309
|
+
*/
|
|
4310
|
+
readonly balance_cents: number;
|
|
4311
|
+
};
|
|
3910
4312
|
/** @description Error response when application cannot be submitted because applicants are not ready */
|
|
3911
4313
|
readonly ApplicationNotReadyError: {
|
|
3912
4314
|
/**
|
|
@@ -4105,6 +4507,36 @@ type components = {
|
|
|
4105
4507
|
readonly EndingBeforeParam: components["schemas"]["KSUID"];
|
|
4106
4508
|
/** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. */
|
|
4107
4509
|
readonly LimitParam: number;
|
|
4510
|
+
/**
|
|
4511
|
+
* @description Sandbox-only. Sets the HTTP status code returned when the sandbox injects an error at the configured step (see `X-Sandbox-Error-Step`). Must be a valid HTTP status code in the range 100-599; values outside that range are ignored. Status codes >= 400 cause the request to short-circuit immediately with a structured error response.
|
|
4512
|
+
* Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
|
|
4513
|
+
*/
|
|
4514
|
+
readonly SandboxErrorStatusHeader: number;
|
|
4515
|
+
/**
|
|
4516
|
+
* @description Sandbox-only. Sets the human-readable `message` field of the injected sandbox error response. Truncated values longer than 500 characters are ignored.
|
|
4517
|
+
* Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
|
|
4518
|
+
*/
|
|
4519
|
+
readonly SandboxErrorMessageHeader: string;
|
|
4520
|
+
/**
|
|
4521
|
+
* @description Sandbox-only. Names the pipeline step at which the injected error fires. Pair with `X-Sandbox-Error-Status` and (optionally) `X-Sandbox-Error-Message` to drive a deterministic failure mode at a known point in the request lifecycle. Values longer than 100 characters are ignored.
|
|
4522
|
+
* Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
|
|
4523
|
+
*/
|
|
4524
|
+
readonly SandboxErrorStepHeader: "transaction_processing" | "compliance_check" | "account_validation" | "provider_call" | "kyb_submission" | "kyb_approval" | "network_call";
|
|
4525
|
+
/**
|
|
4526
|
+
* @description Sandbox-only. Applies a preset failure or behavior mode for the request, selecting a coherent combination of error step, status, and message. The full set of scenarios is also exposed dynamically via `GET /sandbox/scenarios` along with descriptions and per-rail applicability.
|
|
4527
|
+
* Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
|
|
4528
|
+
*/
|
|
4529
|
+
readonly SandboxScenarioHeader: "happy_path" | "delayed_settlement" | "insufficient_funds" | "compliance_block" | "invalid_account" | "provider_maintenance" | "network_congestion" | "kyb_manual_review" | "kyb_rejected" | "kyb_expired" | "network_timeout" | "intermittent_errors" | "account_frozen" | "document_expired" | "invalid_swift";
|
|
4530
|
+
/**
|
|
4531
|
+
* @description Sandbox-only. When `true`, asynchronous simulation flows complete immediately rather than progressing through their normal timed states. Useful for fast end-to-end test runs that do not need to exercise intermediate webhook events. Accepts `true`/`false` (also `1`/`0`, `yes`/`no`); other values are treated as `false`.
|
|
4532
|
+
* Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
|
|
4533
|
+
*/
|
|
4534
|
+
readonly SandboxInstantCompletionHeader: boolean;
|
|
4535
|
+
/**
|
|
4536
|
+
* @description Sandbox-only. When `true`, prevents the default 5-second KYB auto-approval that the sandbox applies to newly created customers. Use this header (typically with `X-Sandbox-Scenario: kyb_manual_review` or `kyb_rejected`) to keep an application in `pending` so integrators can exercise manual-review and rejection flows. Accepts `true`/`false` (also `1`/`0`, `yes`/`no`); other values are treated as `false`.
|
|
4537
|
+
* Effective only on `https://api.platform.sandbox.dakota.xyz`. Ignored in production.
|
|
4538
|
+
*/
|
|
4539
|
+
readonly SandboxSkipAutoApprovalHeader: boolean;
|
|
4108
4540
|
};
|
|
4109
4541
|
requestBodies: never;
|
|
4110
4542
|
headers: never;
|
|
@@ -4146,6 +4578,26 @@ type KybStatus = Customer['kyb_status'];
|
|
|
4146
4578
|
type UpdateCustomerSubClientRequest = components['schemas']['UpdateCustomerSubClientRequest'];
|
|
4147
4579
|
/** Summary of a sub-client including the count of associated customers */
|
|
4148
4580
|
type SubClientSummary = components['schemas']['SubClientSummary'];
|
|
4581
|
+
/** Request body for bulk-importing customers from Sumsub share tokens */
|
|
4582
|
+
interface BulkImportSumsubTokensRequest {
|
|
4583
|
+
/** List of Sumsub share tokens to import */
|
|
4584
|
+
tokens: string[];
|
|
4585
|
+
}
|
|
4586
|
+
/** Per-token outcome for a bulk Sumsub import */
|
|
4587
|
+
interface BulkImportSumsubTokensResult {
|
|
4588
|
+
name?: string;
|
|
4589
|
+
success?: boolean;
|
|
4590
|
+
customer_id?: string;
|
|
4591
|
+
application_id?: string;
|
|
4592
|
+
error?: string;
|
|
4593
|
+
}
|
|
4594
|
+
/** Response from bulk-importing customers from Sumsub share tokens */
|
|
4595
|
+
interface BulkImportSumsubTokensResponse {
|
|
4596
|
+
total?: number;
|
|
4597
|
+
succeeded?: number;
|
|
4598
|
+
failed?: number;
|
|
4599
|
+
results?: BulkImportSumsubTokensResult[];
|
|
4600
|
+
}
|
|
4149
4601
|
/** Recipient response */
|
|
4150
4602
|
type Recipient = components['schemas']['RecipientResponse'];
|
|
4151
4603
|
/** Recipient creation request */
|
|
@@ -4202,6 +4654,10 @@ type WalletBalances = components['schemas']['WalletBalances'];
|
|
|
4202
4654
|
type WalletTransactionRequest = components['schemas']['SendTransactionIntent'];
|
|
4203
4655
|
/** Wallet transaction response */
|
|
4204
4656
|
type WalletTransaction = components['schemas']['WalletTransaction'];
|
|
4657
|
+
/** Slim reference to a policy attached to a wallet (id + name) */
|
|
4658
|
+
type AttachedPolicy = components['schemas']['AttachedPolicy'];
|
|
4659
|
+
/** Slim reference to a wallet attached to a policy or signer group (id + name + family) */
|
|
4660
|
+
type AttachedWallet = components['schemas']['AttachedWallet'];
|
|
4205
4661
|
/** Event */
|
|
4206
4662
|
type Event = components['schemas']['Event'];
|
|
4207
4663
|
/** Event type */
|
|
@@ -4628,6 +5084,15 @@ type SelfServeCreditsLedgerResponse = components['schemas']['SelfServeCreditsLed
|
|
|
4628
5084
|
type SelfServeCreditTier = components['schemas']['SelfServeCreditTier'];
|
|
4629
5085
|
/** Self-serve credit tiers response */
|
|
4630
5086
|
type SelfServeCreditTiersResponse = components['schemas']['SelfServeCreditTiersResponse'];
|
|
5087
|
+
/** Self-serve client pricing configuration (fee schedule) */
|
|
5088
|
+
type ClientPricingConfig = components['schemas']['ClientPricingConfig'];
|
|
5089
|
+
/**
|
|
5090
|
+
* Self-serve credits pricing response.
|
|
5091
|
+
*
|
|
5092
|
+
* Returned by `GET /self-serve/credits/pricing` — the caller's current
|
|
5093
|
+
* `ClientPricingConfig` (transfer/ACH/wire/SEPA/SWIFT/KYC/KYB fees + monthly minimum).
|
|
5094
|
+
*/
|
|
5095
|
+
type SelfServeCreditsPricingResponse = ClientPricingConfig;
|
|
4631
5096
|
/** Ledger entry type filter */
|
|
4632
5097
|
type SelfServeCreditsLedgerEntryType = SelfServeCreditsLedgerEntry['entry_type'];
|
|
4633
5098
|
/** Parameters for listing self-serve credits ledger entries */
|
|
@@ -4810,6 +5275,29 @@ declare class CustomersResource extends BaseResource {
|
|
|
4810
5275
|
* ```
|
|
4811
5276
|
*/
|
|
4812
5277
|
getSubClientSummary(): Promise<SubClientSummary[]>;
|
|
5278
|
+
/**
|
|
5279
|
+
* Bulk-import customers from Sumsub share tokens.
|
|
5280
|
+
*
|
|
5281
|
+
* Exchanges one or more Sumsub share tokens for Dakota customers + applications.
|
|
5282
|
+
* The response surfaces per-token results — individual tokens can fail while
|
|
5283
|
+
* others succeed.
|
|
5284
|
+
*
|
|
5285
|
+
* @param data - Bulk-import request containing the share tokens to redeem
|
|
5286
|
+
* @param options - Request options (e.g., custom idempotency key)
|
|
5287
|
+
* @returns Bulk-import summary with per-token results
|
|
5288
|
+
*
|
|
5289
|
+
* @example
|
|
5290
|
+
* ```typescript
|
|
5291
|
+
* const result = await client.customers.bulkImportFromSumsubTokens({
|
|
5292
|
+
* tokens: ['_act-sbx-jwt-...', '_act-sbx-jwt-...'],
|
|
5293
|
+
* });
|
|
5294
|
+
* console.log(`Imported ${result.succeeded}/${result.total}`);
|
|
5295
|
+
* for (const r of result.results ?? []) {
|
|
5296
|
+
* if (!r.success) console.error(r.name, r.error);
|
|
5297
|
+
* }
|
|
5298
|
+
* ```
|
|
5299
|
+
*/
|
|
5300
|
+
bulkImportFromSumsubTokens(data: BulkImportSumsubTokensRequest, options?: RequestOptions): Promise<BulkImportSumsubTokensResponse>;
|
|
4813
5301
|
}
|
|
4814
5302
|
|
|
4815
5303
|
/**
|
|
@@ -5214,6 +5702,36 @@ declare class WalletsResource extends BaseResource {
|
|
|
5214
5702
|
* ```
|
|
5215
5703
|
*/
|
|
5216
5704
|
create(data: WalletCreateRequest, options?: RequestOptions): Promise<Wallet>;
|
|
5705
|
+
/**
|
|
5706
|
+
* Get a single wallet by ID.
|
|
5707
|
+
*
|
|
5708
|
+
* @param walletId - Wallet ID
|
|
5709
|
+
* @returns Wallet record (includes `customer_name` and `created_at`)
|
|
5710
|
+
*
|
|
5711
|
+
* @example
|
|
5712
|
+
* ```typescript
|
|
5713
|
+
* const wallet = await client.wallets.get(walletId);
|
|
5714
|
+
* console.log(wallet.address, wallet.customer_name);
|
|
5715
|
+
* ```
|
|
5716
|
+
*/
|
|
5717
|
+
get(walletId: string): Promise<Wallet>;
|
|
5718
|
+
/**
|
|
5719
|
+
* Get policies attached to a wallet.
|
|
5720
|
+
*
|
|
5721
|
+
* Returns slim references (id + name) for the policies currently attached to the wallet.
|
|
5722
|
+
*
|
|
5723
|
+
* @param walletId - Wallet ID
|
|
5724
|
+
* @returns Array of attached policies
|
|
5725
|
+
*
|
|
5726
|
+
* @example
|
|
5727
|
+
* ```typescript
|
|
5728
|
+
* const policies = await client.wallets.getPolicies(walletId);
|
|
5729
|
+
* for (const policy of policies) {
|
|
5730
|
+
* console.log(policy.id, policy.name);
|
|
5731
|
+
* }
|
|
5732
|
+
* ```
|
|
5733
|
+
*/
|
|
5734
|
+
getPolicies(walletId: string): Promise<AttachedPolicy[]>;
|
|
5217
5735
|
/**
|
|
5218
5736
|
* Get wallet balances.
|
|
5219
5737
|
*
|
|
@@ -5532,6 +6050,15 @@ declare class PoliciesResource extends BaseResource {
|
|
|
5532
6050
|
* @param ruleId - Rule ID
|
|
5533
6051
|
*/
|
|
5534
6052
|
deleteRule(policyId: string, ruleId: string): Promise<void>;
|
|
6053
|
+
/**
|
|
6054
|
+
* Get wallets attached to a policy.
|
|
6055
|
+
*
|
|
6056
|
+
* Returns slim references (id + name + family) for the wallets the policy is currently attached to.
|
|
6057
|
+
*
|
|
6058
|
+
* @param policyId - Policy ID
|
|
6059
|
+
* @returns Array of attached wallets
|
|
6060
|
+
*/
|
|
6061
|
+
getWallets(policyId: string): Promise<AttachedWallet[]>;
|
|
5535
6062
|
/**
|
|
5536
6063
|
* Attach a policy to a wallet.
|
|
5537
6064
|
*
|
|
@@ -5592,6 +6119,15 @@ declare class SignerGroupsResource extends BaseResource {
|
|
|
5592
6119
|
* @param signerId - Signer ID
|
|
5593
6120
|
*/
|
|
5594
6121
|
removeSigner(signerGroupId: string, signerId: string): Promise<void>;
|
|
6122
|
+
/**
|
|
6123
|
+
* Get wallets attached to a signer group.
|
|
6124
|
+
*
|
|
6125
|
+
* Returns slim references (id + name + family) for the wallets the signer group is currently attached to.
|
|
6126
|
+
*
|
|
6127
|
+
* @param signerGroupId - Signer group ID
|
|
6128
|
+
* @returns Array of attached wallets
|
|
6129
|
+
*/
|
|
6130
|
+
getWallets(signerGroupId: string): Promise<AttachedWallet[]>;
|
|
5595
6131
|
/**
|
|
5596
6132
|
* Attach a signer group to a wallet.
|
|
5597
6133
|
*
|
|
@@ -6121,6 +6657,22 @@ declare class SelfServeResource extends BaseResource {
|
|
|
6121
6657
|
* ```
|
|
6122
6658
|
*/
|
|
6123
6659
|
listTiers(): Promise<SelfServeCreditTiersResponse>;
|
|
6660
|
+
/**
|
|
6661
|
+
* Get the self-serve client's pricing config (fee schedule).
|
|
6662
|
+
*
|
|
6663
|
+
* Returns the caller's current `ClientPricingConfig` — transfer/ACH/wire/SEPA/SWIFT/KYC/KYB
|
|
6664
|
+
* fees plus the monthly minimum. Self-serve clients only.
|
|
6665
|
+
*
|
|
6666
|
+
* @returns The current pricing configuration
|
|
6667
|
+
*
|
|
6668
|
+
* @example
|
|
6669
|
+
* ```typescript
|
|
6670
|
+
* const pricing = await client.selfServe.getPricing();
|
|
6671
|
+
* console.log(`ACH fee: ${pricing.achFeeCents} cents`);
|
|
6672
|
+
* console.log(`Wire fee: ${pricing.wireFeeCents} cents`);
|
|
6673
|
+
* ```
|
|
6674
|
+
*/
|
|
6675
|
+
getPricing(): Promise<SelfServeCreditsPricingResponse>;
|
|
6124
6676
|
}
|
|
6125
6677
|
|
|
6126
6678
|
/**
|
|
@@ -6277,4 +6829,4 @@ declare class ConfigurationError extends Error {
|
|
|
6277
6829
|
constructor(message: string);
|
|
6278
6830
|
}
|
|
6279
6831
|
|
|
6280
|
-
export { APIError, type Account, type AccountCreateRequest, type AccountListParams, type AccountUpdateRequest, AccountsResource, type Address, type AdvanceSimulationRequest, type AdvanceSimulationResult, type ApiKey, type ApiKeyCreateRequest, type ApiKeyResponse, ApiKeysResource, type Application, type ApplicationDocumentType, type ApplicationDocumentUploadRequest, type ApplicationDocumentUploadUrlRequest, type ApplicationListItem, type ApplicationStatus, type ApplicationSubmissionRequest, ApplicationsResource, type AssociatedIndividual, type AssociatedIndividualRequest, type AttestationSubmitRequest, type AttestationType, AuthMode, type AutoTransaction, AutoTransactionsResource, type AverageMonthlyRevenue, type BusinessApplicationCreateRequest, type BusinessDetailsResponse, type BusinessPurposeOfAccount, type BusinessSourceOfFunds, ConfigurationError, type Country, type CreateApiKeyForClientRequest, type CryptoDestination, type CryptoDestinationRequest, type CursorExtractor, type Customer, type CustomerCreateRequest, type CustomerCreateResponse, type CustomerListParams, CustomersResource, DEFAULT_RETRY_POLICY, DakotaClient, type DakotaClientConfig, type Destination, type DestinationRequest, DestinationsResource, type DocumentUploadResponse, type DocumentUploadUrlResponse, type EDDRequest, type EDDWithApplicationID, type EmploymentStatus, Environment, type Event, type EventListParams, type EventType, EventsResource, type ExpectedMonthlyDeposit, type Family, type FiatUSDestination, type FiatUSDestinationRequest, type IndividualDetailsResponse, type IndividualDocumentType, type IndividualDocumentUploadRequest, type IndividualDocumentUploadUrlRequest, type IndividualRequest, type IndividualRole, type IndividualTitle, InfoResource, type KSUID, type KybStatus, type LegalStructure, type ListParams, type Logger, type Meta, type Network, type NetworkId, type OfframpAccount, type OfframpAccountCreateRequest, type OneOffTransaction, type OneOffTransactionRequest, type OnrampAccount, type OnrampAccountCreateRequest, type PageFetcher, PaginatedIterator, type PaginatedResponse, type PaginationMeta, type PaginationParams, type PaymentCapability, type PersonName, PoliciesResource, type Policy, type PolicyCreateRequest, type PolicyRule, type PolicyRuleCreateRequest, type Recipient, type RecipientRequest, type RecipientUpdateRequest, RecipientsResource, type RequestOptions, type ResolvedConfig, type RetryPolicy, SandboxResource, type SandboxScenario, type SelfServeCreditTier, type SelfServeCreditTiersResponse, type SelfServeCreditsBalanceResponse, type SelfServeCreditsLedgerEntry, type SelfServeCreditsLedgerEntryType, type SelfServeCreditsLedgerParams, type SelfServeCreditsLedgerResponse, type SelfServeCreditsPurchaseRequest, type SelfServeCreditsPurchaseResponse, SelfServeResource, type Signer, type SignerCreateRequest, type SignerGroup, type SignerGroupCreateRequest, SignerGroupsResource, SignersResource, type SimulateInboundRequest, type SimulateInboundType, type SimulateOnboardingRequest, type SimulateOnboardingResponse, type SimulateOnboardingType, type SimulationCallbackRecord, type SimulationInspection, type SimulationResponse, type SubClientSummary, type SwapAccount, type SwapAccountCreateRequest, type TransactionListParams, type TransactionStatus, TransactionsResource, TransportError, type UpdateCustomerSubClientRequest, type UploadedDocumentMetadata, type User, type UserCreateRequest, type UserUpdateRequest, UsersResource, type Wallet, type WalletBalance, type WalletBalances, type WalletCreateRequest, type WalletTransaction, type WalletTransactionRequest, WalletsResource, type WebhookEvent, type WebhookHistoryList, type WebhookHistoryListParams, type WebhookHistoryResponse, type WebhookReplayResponse, type WebhookTarget, type WebhookTargetCreateRequest, type WebhookTargetUpdateRequest, WebhooksResource, consoleLogger, getEnvironmentURL, noopLogger, paginate };
|
|
6832
|
+
export { APIError, type Account, type AccountCreateRequest, type AccountListParams, type AccountUpdateRequest, AccountsResource, type Address, type AdvanceSimulationRequest, type AdvanceSimulationResult, type ApiKey, type ApiKeyCreateRequest, type ApiKeyResponse, ApiKeysResource, type Application, type ApplicationDocumentType, type ApplicationDocumentUploadRequest, type ApplicationDocumentUploadUrlRequest, type ApplicationListItem, type ApplicationStatus, type ApplicationSubmissionRequest, ApplicationsResource, type AssociatedIndividual, type AssociatedIndividualRequest, type AttachedPolicy, type AttachedWallet, type AttestationSubmitRequest, type AttestationType, AuthMode, type AutoTransaction, AutoTransactionsResource, type AverageMonthlyRevenue, type BulkImportSumsubTokensRequest, type BulkImportSumsubTokensResponse, type BulkImportSumsubTokensResult, type BusinessApplicationCreateRequest, type BusinessDetailsResponse, type BusinessPurposeOfAccount, type BusinessSourceOfFunds, type ClientPricingConfig, ConfigurationError, type Country, type CreateApiKeyForClientRequest, type CryptoDestination, type CryptoDestinationRequest, type CursorExtractor, type Customer, type CustomerCreateRequest, type CustomerCreateResponse, type CustomerListParams, CustomersResource, DEFAULT_RETRY_POLICY, DakotaClient, type DakotaClientConfig, type Destination, type DestinationRequest, DestinationsResource, type DocumentUploadResponse, type DocumentUploadUrlResponse, type EDDRequest, type EDDWithApplicationID, type EmploymentStatus, Environment, type Event, type EventListParams, type EventType, EventsResource, type ExpectedMonthlyDeposit, type Family, type FiatUSDestination, type FiatUSDestinationRequest, type IndividualDetailsResponse, type IndividualDocumentType, type IndividualDocumentUploadRequest, type IndividualDocumentUploadUrlRequest, type IndividualRequest, type IndividualRole, type IndividualTitle, InfoResource, type KSUID, type KybStatus, type LegalStructure, type ListParams, type Logger, type Meta, type Network, type NetworkId, type OfframpAccount, type OfframpAccountCreateRequest, type OneOffTransaction, type OneOffTransactionRequest, type OnrampAccount, type OnrampAccountCreateRequest, type PageFetcher, PaginatedIterator, type PaginatedResponse, type PaginationMeta, type PaginationParams, type PaymentCapability, type PersonName, PoliciesResource, type Policy, type PolicyCreateRequest, type PolicyRule, type PolicyRuleCreateRequest, type Recipient, type RecipientRequest, type RecipientUpdateRequest, RecipientsResource, type RequestOptions, type ResolvedConfig, type RetryPolicy, SandboxResource, type SandboxScenario, type SelfServeCreditTier, type SelfServeCreditTiersResponse, type SelfServeCreditsBalanceResponse, type SelfServeCreditsLedgerEntry, type SelfServeCreditsLedgerEntryType, type SelfServeCreditsLedgerParams, type SelfServeCreditsLedgerResponse, type SelfServeCreditsPricingResponse, type SelfServeCreditsPurchaseRequest, type SelfServeCreditsPurchaseResponse, SelfServeResource, type Signer, type SignerCreateRequest, type SignerGroup, type SignerGroupCreateRequest, SignerGroupsResource, SignersResource, type SimulateInboundRequest, type SimulateInboundType, type SimulateOnboardingRequest, type SimulateOnboardingResponse, type SimulateOnboardingType, type SimulationCallbackRecord, type SimulationInspection, type SimulationResponse, type SubClientSummary, type SwapAccount, type SwapAccountCreateRequest, type TransactionListParams, type TransactionStatus, TransactionsResource, TransportError, type UpdateCustomerSubClientRequest, type UploadedDocumentMetadata, type User, type UserCreateRequest, type UserUpdateRequest, UsersResource, type Wallet, type WalletBalance, type WalletBalances, type WalletCreateRequest, type WalletTransaction, type WalletTransactionRequest, WalletsResource, type WebhookEvent, type WebhookHistoryList, type WebhookHistoryListParams, type WebhookHistoryResponse, type WebhookReplayResponse, type WebhookTarget, type WebhookTargetCreateRequest, type WebhookTargetUpdateRequest, WebhooksResource, consoleLogger, getEnvironmentURL, noopLogger, paginate };
|