squarefi-bff-api-module 1.36.33 → 1.36.35
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/types/autogen/apiV1External.types.d.ts +5 -5
- package/dist/api/types/autogen/apiV1Frontend.types.d.ts +219 -10
- package/dist/api/types/autogen/apiV1Legacy.types.d.ts +99 -9
- package/dist/api/types/autogen/apiV2.types.d.ts +6 -6
- package/dist/api/types/types.d.ts +1 -1
- package/dist/constants.d.ts +42 -5
- package/dist/constants.js +35 -0
- package/package.json +1 -1
|
@@ -6332,13 +6332,13 @@ export interface paths {
|
|
|
6332
6332
|
get: {
|
|
6333
6333
|
parameters: {
|
|
6334
6334
|
query?: {
|
|
6335
|
-
/** @description Filter by status (comma-separated for multi-select) */
|
|
6335
|
+
/** @description Filter by status (comma-separated for multi-select — new, pending, processing, complete, canceled, failed) */
|
|
6336
6336
|
status?: string;
|
|
6337
|
-
/** @description Transaction type
|
|
6338
|
-
type?:
|
|
6337
|
+
/** @description Transaction type (direction) */
|
|
6338
|
+
type?: "deposit" | "withdrawal";
|
|
6339
6339
|
/** @description Transaction method filter */
|
|
6340
|
-
method?:
|
|
6341
|
-
/** @description
|
|
6340
|
+
method?: "p2p" | "crypto" | "bank_transfer" | "exchange" | "sbp" | "internal_fiat";
|
|
6341
|
+
/** @description Transaction subtype (e.g. `DEPOSIT_CRYPTO_EXTERNAL`, `CARD_PROVIDER_DEPOSIT`) */
|
|
6342
6342
|
record_type?: string;
|
|
6343
6343
|
/** @description Filter by sender or recipient address (matches `from` OR `to` fields) */
|
|
6344
6344
|
address?: string;
|
|
@@ -7657,6 +7657,208 @@ export interface paths {
|
|
|
7657
7657
|
patch?: never;
|
|
7658
7658
|
trace?: never;
|
|
7659
7659
|
};
|
|
7660
|
+
"/frontend/user_verification/init": {
|
|
7661
|
+
parameters: {
|
|
7662
|
+
query?: never;
|
|
7663
|
+
header?: never;
|
|
7664
|
+
path?: never;
|
|
7665
|
+
cookie?: never;
|
|
7666
|
+
};
|
|
7667
|
+
get?: never;
|
|
7668
|
+
put?: never;
|
|
7669
|
+
/**
|
|
7670
|
+
* Initialize user-level Sumsub verification
|
|
7671
|
+
* @description Starts (or upgrades) the caller's user-level Sumsub verification via
|
|
7672
|
+
* the Auth API. The chosen `flow` maps to a tenant-configured Sumsub
|
|
7673
|
+
* level — `data` (personal information), `documents` (+identity
|
|
7674
|
+
* document) or `face` (+face check) — and the whole level is completed
|
|
7675
|
+
* as one WebSDK session. Returns the Sumsub applicant id plus a
|
|
7676
|
+
* short-lived WebSDK access token. The caller's Bearer token is
|
|
7677
|
+
* forwarded to the Auth API.
|
|
7678
|
+
*
|
|
7679
|
+
* User-scoped: no wallet is involved, unlike
|
|
7680
|
+
* `/frontend/kyc_verification/{wallet_id}/init`.
|
|
7681
|
+
*
|
|
7682
|
+
* **Authentication**: Bearer token with x-tenant-id header required
|
|
7683
|
+
*
|
|
7684
|
+
*/
|
|
7685
|
+
post: {
|
|
7686
|
+
parameters: {
|
|
7687
|
+
query?: never;
|
|
7688
|
+
header?: never;
|
|
7689
|
+
path?: never;
|
|
7690
|
+
cookie?: never;
|
|
7691
|
+
};
|
|
7692
|
+
requestBody: {
|
|
7693
|
+
content: {
|
|
7694
|
+
"application/json": {
|
|
7695
|
+
/**
|
|
7696
|
+
* @description Verification tier to complete as one SDK session
|
|
7697
|
+
* @enum {string}
|
|
7698
|
+
*/
|
|
7699
|
+
flow: "data" | "documents" | "face";
|
|
7700
|
+
};
|
|
7701
|
+
};
|
|
7702
|
+
};
|
|
7703
|
+
responses: {
|
|
7704
|
+
/** @description User verification initialized */
|
|
7705
|
+
200: {
|
|
7706
|
+
headers: {
|
|
7707
|
+
[name: string]: unknown;
|
|
7708
|
+
};
|
|
7709
|
+
content: {
|
|
7710
|
+
"application/json": {
|
|
7711
|
+
/** @example true */
|
|
7712
|
+
success: boolean;
|
|
7713
|
+
data: {
|
|
7714
|
+
/**
|
|
7715
|
+
* @description Echo of the requested flow
|
|
7716
|
+
* @enum {string}
|
|
7717
|
+
*/
|
|
7718
|
+
flow: "data" | "documents" | "face";
|
|
7719
|
+
/** @description Sumsub applicantId */
|
|
7720
|
+
verification_id: string;
|
|
7721
|
+
/** @description Short-lived WebSDK access token — otherwise null */
|
|
7722
|
+
verification_token?: string | null;
|
|
7723
|
+
};
|
|
7724
|
+
};
|
|
7725
|
+
};
|
|
7726
|
+
};
|
|
7727
|
+
/** @description Validation error (`flow` missing or not in [data, documents, face]) */
|
|
7728
|
+
400: {
|
|
7729
|
+
headers: {
|
|
7730
|
+
[name: string]: unknown;
|
|
7731
|
+
};
|
|
7732
|
+
content: {
|
|
7733
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7734
|
+
};
|
|
7735
|
+
};
|
|
7736
|
+
/** @description Missing or invalid Bearer token */
|
|
7737
|
+
401: {
|
|
7738
|
+
headers: {
|
|
7739
|
+
[name: string]: unknown;
|
|
7740
|
+
};
|
|
7741
|
+
content: {
|
|
7742
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7743
|
+
};
|
|
7744
|
+
};
|
|
7745
|
+
/** @description User verification is not enabled for the tenant (no Sumsub levels configured) */
|
|
7746
|
+
404: {
|
|
7747
|
+
headers: {
|
|
7748
|
+
[name: string]: unknown;
|
|
7749
|
+
};
|
|
7750
|
+
content: {
|
|
7751
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7752
|
+
};
|
|
7753
|
+
};
|
|
7754
|
+
/** @description A concurrent init for the same user is in progress (per-user lock) */
|
|
7755
|
+
409: {
|
|
7756
|
+
headers: {
|
|
7757
|
+
[name: string]: unknown;
|
|
7758
|
+
};
|
|
7759
|
+
content: {
|
|
7760
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7761
|
+
};
|
|
7762
|
+
};
|
|
7763
|
+
/** @description Auth API unavailable, timed out, or returned a malformed payload */
|
|
7764
|
+
502: {
|
|
7765
|
+
headers: {
|
|
7766
|
+
[name: string]: unknown;
|
|
7767
|
+
};
|
|
7768
|
+
content: {
|
|
7769
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7770
|
+
};
|
|
7771
|
+
};
|
|
7772
|
+
};
|
|
7773
|
+
};
|
|
7774
|
+
delete?: never;
|
|
7775
|
+
options?: never;
|
|
7776
|
+
head?: never;
|
|
7777
|
+
patch?: never;
|
|
7778
|
+
trace?: never;
|
|
7779
|
+
};
|
|
7780
|
+
"/frontend/user_verification/resume": {
|
|
7781
|
+
parameters: {
|
|
7782
|
+
query?: never;
|
|
7783
|
+
header?: never;
|
|
7784
|
+
path?: never;
|
|
7785
|
+
cookie?: never;
|
|
7786
|
+
};
|
|
7787
|
+
get?: never;
|
|
7788
|
+
put?: never;
|
|
7789
|
+
/**
|
|
7790
|
+
* Resume user-level Sumsub verification
|
|
7791
|
+
* @description Re-issues the short-lived WebSDK access token for the level the caller
|
|
7792
|
+
* is already on (the WebSDK's expirationHandler contract). The caller's
|
|
7793
|
+
* Bearer token is forwarded to the Auth API.
|
|
7794
|
+
*
|
|
7795
|
+
* **Authentication**: Bearer token with x-tenant-id header required
|
|
7796
|
+
*
|
|
7797
|
+
*/
|
|
7798
|
+
post: {
|
|
7799
|
+
parameters: {
|
|
7800
|
+
query?: never;
|
|
7801
|
+
header?: never;
|
|
7802
|
+
path?: never;
|
|
7803
|
+
cookie?: never;
|
|
7804
|
+
};
|
|
7805
|
+
requestBody?: never;
|
|
7806
|
+
responses: {
|
|
7807
|
+
/** @description User verification resumed */
|
|
7808
|
+
200: {
|
|
7809
|
+
headers: {
|
|
7810
|
+
[name: string]: unknown;
|
|
7811
|
+
};
|
|
7812
|
+
content: {
|
|
7813
|
+
"application/json": {
|
|
7814
|
+
/** @example true */
|
|
7815
|
+
success: boolean;
|
|
7816
|
+
data: {
|
|
7817
|
+
/** @description Always null on resume — the Auth API resumes the current level */
|
|
7818
|
+
flow?: string | null;
|
|
7819
|
+
/** @description Sumsub applicantId */
|
|
7820
|
+
verification_id: string;
|
|
7821
|
+
/** @description Short-lived WebSDK access token — otherwise null */
|
|
7822
|
+
verification_token?: string | null;
|
|
7823
|
+
};
|
|
7824
|
+
};
|
|
7825
|
+
};
|
|
7826
|
+
};
|
|
7827
|
+
/** @description Missing or invalid Bearer token */
|
|
7828
|
+
401: {
|
|
7829
|
+
headers: {
|
|
7830
|
+
[name: string]: unknown;
|
|
7831
|
+
};
|
|
7832
|
+
content: {
|
|
7833
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7834
|
+
};
|
|
7835
|
+
};
|
|
7836
|
+
/** @description Verification not initialized for this user */
|
|
7837
|
+
404: {
|
|
7838
|
+
headers: {
|
|
7839
|
+
[name: string]: unknown;
|
|
7840
|
+
};
|
|
7841
|
+
content: {
|
|
7842
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7843
|
+
};
|
|
7844
|
+
};
|
|
7845
|
+
/** @description Auth API unavailable, timed out, or returned a malformed payload */
|
|
7846
|
+
502: {
|
|
7847
|
+
headers: {
|
|
7848
|
+
[name: string]: unknown;
|
|
7849
|
+
};
|
|
7850
|
+
content: {
|
|
7851
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7852
|
+
};
|
|
7853
|
+
};
|
|
7854
|
+
};
|
|
7855
|
+
};
|
|
7856
|
+
delete?: never;
|
|
7857
|
+
options?: never;
|
|
7858
|
+
head?: never;
|
|
7859
|
+
patch?: never;
|
|
7860
|
+
trace?: never;
|
|
7861
|
+
};
|
|
7660
7862
|
"/frontend/virtual-accounts/wallet/{wallet_id}": {
|
|
7661
7863
|
parameters: {
|
|
7662
7864
|
query?: never;
|
|
@@ -9556,13 +9758,13 @@ export interface paths {
|
|
|
9556
9758
|
sort_by?: string;
|
|
9557
9759
|
/** @description Sort direction */
|
|
9558
9760
|
sort_order?: "ASC" | "DESC";
|
|
9559
|
-
/** @description Comma-separated transaction statuses (
|
|
9761
|
+
/** @description Comma-separated transaction statuses (new, pending, processing, complete, canceled, failed) */
|
|
9560
9762
|
status?: string;
|
|
9561
|
-
/** @description Transaction type
|
|
9562
|
-
type?:
|
|
9763
|
+
/** @description Transaction type (direction) */
|
|
9764
|
+
type?: "deposit" | "withdrawal";
|
|
9563
9765
|
/** @description Transaction method filter */
|
|
9564
|
-
method?:
|
|
9565
|
-
/** @description
|
|
9766
|
+
method?: "p2p" | "crypto" | "bank_transfer" | "exchange" | "sbp" | "internal_fiat";
|
|
9767
|
+
/** @description Transaction subtype (e.g. `DEPOSIT_CRYPTO_EXTERNAL`, `CARD_PROVIDER_DEPOSIT`) */
|
|
9566
9768
|
record_type?: string;
|
|
9567
9769
|
/** @description Filter by sender or recipient address (matches `from` OR `to` fields) */
|
|
9568
9770
|
address?: string;
|
|
@@ -9662,13 +9864,13 @@ export interface paths {
|
|
|
9662
9864
|
get: {
|
|
9663
9865
|
parameters: {
|
|
9664
9866
|
query?: {
|
|
9665
|
-
/** @description Filter by status (comma-separated for multi-select,
|
|
9867
|
+
/** @description Filter by status (comma-separated for multi-select — new, pending, processing, complete, canceled, failed) */
|
|
9666
9868
|
status?: string;
|
|
9667
|
-
/** @description Transaction type
|
|
9668
|
-
type?:
|
|
9869
|
+
/** @description Transaction type (direction) */
|
|
9870
|
+
type?: "deposit" | "withdrawal";
|
|
9669
9871
|
/** @description Transaction method filter */
|
|
9670
|
-
method?:
|
|
9671
|
-
/** @description
|
|
9872
|
+
method?: "p2p" | "crypto" | "bank_transfer" | "exchange" | "sbp" | "internal_fiat";
|
|
9873
|
+
/** @description Transaction subtype (e.g. `DEPOSIT_CRYPTO_EXTERNAL`, `CARD_PROVIDER_DEPOSIT`) */
|
|
9672
9874
|
record_type?: string;
|
|
9673
9875
|
/** @description Filter by sender or recipient address (matches `from` OR `to` fields) */
|
|
9674
9876
|
address?: string;
|
|
@@ -9874,6 +10076,13 @@ export interface paths {
|
|
|
9874
10076
|
first_name?: string;
|
|
9875
10077
|
last_name?: string;
|
|
9876
10078
|
logo_url?: string;
|
|
10079
|
+
/**
|
|
10080
|
+
* @description Outcome of the member's Sumsub IDENTITY-document step.
|
|
10081
|
+
* `APPROVED` is the only value that permits issuing a card to this member.
|
|
10082
|
+
*
|
|
10083
|
+
* @enum {string}
|
|
10084
|
+
*/
|
|
10085
|
+
identity_verification_status?: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
|
|
9877
10086
|
};
|
|
9878
10087
|
}[];
|
|
9879
10088
|
pagination?: components["schemas"]["PaginationResponse"];
|
|
@@ -8035,27 +8035,70 @@ export interface components {
|
|
|
8035
8035
|
country?: string | null;
|
|
8036
8036
|
};
|
|
8037
8037
|
};
|
|
8038
|
-
/** @description Bank account information of the sender
|
|
8038
|
+
/** @description Bank account information of the sender.
|
|
8039
|
+
*
|
|
8040
|
+
* Every key below is always present; a value the payment rail did not
|
|
8041
|
+
* provide is an empty string. Identifiers are placed by what the value
|
|
8042
|
+
* IS, not by what the rail called it: an IBAN is always in `iban` (never
|
|
8043
|
+
* in `account_number`) and a SWIFT/BIC is always in `swift_bic` (never in
|
|
8044
|
+
* `routing_number`), including for orders created before this became the
|
|
8045
|
+
* case. So `account_number` and `routing_number` carry domestic
|
|
8046
|
+
* identifiers only.
|
|
8047
|
+
* */
|
|
8039
8048
|
L2FOriginatorAccountInfo: {
|
|
8040
8049
|
/**
|
|
8041
|
-
* @description
|
|
8050
|
+
* @description Domestic bank account number. Empty when the sender's identifier is an IBAN.
|
|
8042
8051
|
* @example 202504243736
|
|
8043
8052
|
*/
|
|
8044
8053
|
account_number?: string;
|
|
8045
8054
|
/**
|
|
8046
|
-
* @description
|
|
8055
|
+
* @description Domestic routing number (US ABA and equivalents). Empty when the value is a BIC.
|
|
8047
8056
|
* @example 91311229
|
|
8048
8057
|
*/
|
|
8049
8058
|
routing_number?: string | null;
|
|
8050
|
-
/**
|
|
8059
|
+
/**
|
|
8060
|
+
* @description Sender's IBAN, for SEPA and SWIFT payments.
|
|
8061
|
+
* @example CZ6508000000192000145399
|
|
8062
|
+
*/
|
|
8063
|
+
iban?: string | null;
|
|
8064
|
+
/**
|
|
8065
|
+
* @description SWIFT BIC code of the sender's bank (for international transfers)
|
|
8066
|
+
* @example FIOBCZPPXXX
|
|
8067
|
+
*/
|
|
8051
8068
|
swift_bic?: string | null;
|
|
8052
|
-
/**
|
|
8069
|
+
/**
|
|
8070
|
+
* @description Sort code of the sender's bank (UK payments)
|
|
8071
|
+
* @example 60-16-13
|
|
8072
|
+
*/
|
|
8073
|
+
sort_code?: string | null;
|
|
8074
|
+
/**
|
|
8075
|
+
* @description Currency of the sender's account, when the rail reports it
|
|
8076
|
+
* @example EUR
|
|
8077
|
+
*/
|
|
8078
|
+
currency_code?: string | null;
|
|
8079
|
+
/**
|
|
8080
|
+
* @description Name of the sender's bank. Often empty — several rails do not report
|
|
8081
|
+
* it, and a value that merely repeats the sender's own name is omitted
|
|
8082
|
+
* rather than presented as a bank.
|
|
8083
|
+
*
|
|
8084
|
+
* @example Fio banka, a.s.
|
|
8085
|
+
*/
|
|
8053
8086
|
institution_name?: string | null;
|
|
8087
|
+
/**
|
|
8088
|
+
* @description Correspondent/intermediary bank, when the payment was routed through one
|
|
8089
|
+
* @example SSB PITTSBURGH
|
|
8090
|
+
*/
|
|
8091
|
+
intermediary_institution_name?: string | null;
|
|
8054
8092
|
};
|
|
8055
8093
|
/**
|
|
8056
|
-
* @description Standardized originator (sender) information for
|
|
8057
|
-
*
|
|
8058
|
-
*
|
|
8094
|
+
* @description Standardized originator (sender) information for incoming fiat payments,
|
|
8095
|
+
* exposed as `order.meta.originator`.
|
|
8096
|
+
*
|
|
8097
|
+
* The shape is the same whichever rail carried the payment — L2F, Brale,
|
|
8098
|
+
* BCB or Delos onramps all normalize into it. Sender details come from the
|
|
8099
|
+
* paying bank, so how much is populated varies by rail and by payment:
|
|
8100
|
+
* `profile.name` is almost always present, while the sender's address is
|
|
8101
|
+
* rarely reported and is often empty for every field.
|
|
8059
8102
|
*
|
|
8060
8103
|
* @example {
|
|
8061
8104
|
* "profile": {
|
|
@@ -8071,8 +8114,12 @@ export interface components {
|
|
|
8071
8114
|
* "account_information": {
|
|
8072
8115
|
* "account_number": "202504243736",
|
|
8073
8116
|
* "routing_number": "91311229",
|
|
8117
|
+
* "iban": "",
|
|
8074
8118
|
* "swift_bic": "",
|
|
8075
|
-
* "
|
|
8119
|
+
* "sort_code": "",
|
|
8120
|
+
* "currency_code": "USD",
|
|
8121
|
+
* "institution_name": "JPMorgan Chase",
|
|
8122
|
+
* "intermediary_institution_name": ""
|
|
8076
8123
|
* },
|
|
8077
8124
|
* "reference": "20251016MMQFMP2U004005",
|
|
8078
8125
|
* "memo": "bfgkp5w"
|
|
@@ -8080,7 +8127,20 @@ export interface components {
|
|
|
8080
8127
|
*/
|
|
8081
8128
|
L2FOriginator: {
|
|
8082
8129
|
profile?: components["schemas"]["L2FOriginatorProfile"];
|
|
8130
|
+
/** @description Sender's bank details. Present on incoming fiat payments only —
|
|
8131
|
+
* an internal transfer carries `wallet_information` instead.
|
|
8132
|
+
* */
|
|
8083
8133
|
account_information?: components["schemas"]["L2FOriginatorAccountInfo"];
|
|
8134
|
+
/** @description Sending wallet, in place of `account_information` when the funds
|
|
8135
|
+
* came from another wallet on the platform rather than from a bank.
|
|
8136
|
+
* */
|
|
8137
|
+
wallet_information?: {
|
|
8138
|
+
/** Format: uuid */
|
|
8139
|
+
wallet_uuid?: string;
|
|
8140
|
+
wallet_name?: string;
|
|
8141
|
+
/** @description Source address for a crypto transfer; null for an internal balance transfer */
|
|
8142
|
+
crypto_address?: string | null;
|
|
8143
|
+
} | null;
|
|
8084
8144
|
/**
|
|
8085
8145
|
* @description Payment reference number (rail_reference from Railio)
|
|
8086
8146
|
* @example 20251016MMQFMP2U004005
|
|
@@ -8092,6 +8152,36 @@ export interface components {
|
|
|
8092
8152
|
*/
|
|
8093
8153
|
memo?: string | null;
|
|
8094
8154
|
} | null;
|
|
8155
|
+
/**
|
|
8156
|
+
* @description Same shape for an inbound SWIFT payment: the sender is identified by an
|
|
8157
|
+
* IBAN and a BIC, so the domestic fields stay empty.
|
|
8158
|
+
*
|
|
8159
|
+
* @example {
|
|
8160
|
+
* "profile": {
|
|
8161
|
+
* "name": "Giovanni Belfiore",
|
|
8162
|
+
* "address": {
|
|
8163
|
+
* "address_line1": "",
|
|
8164
|
+
* "city": "",
|
|
8165
|
+
* "state": "",
|
|
8166
|
+
* "postal_code": "",
|
|
8167
|
+
* "country": ""
|
|
8168
|
+
* }
|
|
8169
|
+
* },
|
|
8170
|
+
* "account_information": {
|
|
8171
|
+
* "account_number": "",
|
|
8172
|
+
* "routing_number": "",
|
|
8173
|
+
* "iban": "CZ6508000000192000145399",
|
|
8174
|
+
* "swift_bic": "FIOBCZPPXXX",
|
|
8175
|
+
* "sort_code": "",
|
|
8176
|
+
* "currency_code": "USD",
|
|
8177
|
+
* "institution_name": "",
|
|
8178
|
+
* "intermediary_institution_name": ""
|
|
8179
|
+
* },
|
|
8180
|
+
* "reference": "5pdbjv4ev351",
|
|
8181
|
+
* "memo": "Fee for services"
|
|
8182
|
+
* }
|
|
8183
|
+
*/
|
|
8184
|
+
L2FOriginatorSwiftExample: components["schemas"]["L2FOriginator"];
|
|
8095
8185
|
/**
|
|
8096
8186
|
* @description Optional array of document objects to attach to the order.
|
|
8097
8187
|
* Documents should be uploaded to a storage service beforehand and only URLs should be provided.
|
|
@@ -1020,17 +1020,17 @@ export interface components {
|
|
|
1020
1020
|
* @default UNVERIFIED
|
|
1021
1021
|
* @enum {string|null}
|
|
1022
1022
|
*/
|
|
1023
|
-
kyc_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW" | null;
|
|
1023
|
+
kyc_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW" | null;
|
|
1024
1024
|
/**
|
|
1025
1025
|
* @default UNVERIFIED
|
|
1026
1026
|
* @enum {string}
|
|
1027
1027
|
*/
|
|
1028
|
-
identity_verification_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
|
|
1028
|
+
identity_verification_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
|
|
1029
1029
|
/**
|
|
1030
1030
|
* @default UNVERIFIED
|
|
1031
1031
|
* @enum {string}
|
|
1032
1032
|
*/
|
|
1033
|
-
face_verification_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
|
|
1033
|
+
face_verification_status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
|
|
1034
1034
|
readonly profile_source: string | null;
|
|
1035
1035
|
readonly profile_synced_at: string | null;
|
|
1036
1036
|
referral_name: string | null;
|
|
@@ -1306,7 +1306,7 @@ export interface components {
|
|
|
1306
1306
|
* @default UNVERIFIED
|
|
1307
1307
|
* @enum {string}
|
|
1308
1308
|
*/
|
|
1309
|
-
status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
|
|
1309
|
+
status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
|
|
1310
1310
|
readonly business_name?: string;
|
|
1311
1311
|
readonly first_name?: string;
|
|
1312
1312
|
readonly last_name?: string;
|
|
@@ -1689,7 +1689,7 @@ export interface components {
|
|
|
1689
1689
|
* @default UNVERIFIED
|
|
1690
1690
|
* @enum {string}
|
|
1691
1691
|
*/
|
|
1692
|
-
status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
|
|
1692
|
+
status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
|
|
1693
1693
|
/** @enum {string|null} */
|
|
1694
1694
|
employment_status?: "EMPLOYEE" | "SELF_EMPLOYED" | "RETIRED" | "UNEMPLOYED" | "STUDENT" | "OTHER" | null;
|
|
1695
1695
|
employment_description?: string | null;
|
|
@@ -1761,7 +1761,7 @@ export interface components {
|
|
|
1761
1761
|
WalletKycRailDto: {
|
|
1762
1762
|
message: string | null;
|
|
1763
1763
|
/** @enum {string} */
|
|
1764
|
-
readonly status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
|
|
1764
|
+
readonly status: "APPROVED" | "DECLINED" | "PENDING" | "PROCESSING" | "HOLD" | "NEEDS_ATTENTION" | "DOUBLE" | "SOFT_REJECT" | "REJECT" | "UNVERIFIED" | "WAITING_ON_UBOS" | "WAITING_ON_REVIEW";
|
|
1765
1765
|
/** @default false */
|
|
1766
1766
|
terms_confirmed: boolean;
|
|
1767
1767
|
extra_actions?: components["schemas"]["WalletKycRailExtraActionDto"][];
|
|
@@ -1562,7 +1562,7 @@ export declare namespace API {
|
|
|
1562
1562
|
}
|
|
1563
1563
|
}
|
|
1564
1564
|
namespace OrderTypes {
|
|
1565
|
-
type PaymentMethod = 'ACH' | 'FEDWIRE' | 'SWIFT' | 'SEPA' | 'SEPA_CT' | 'CHAPS' | 'FPS' | 'CRYPTO_EXTERNAL' | 'CRYPTO_INTERNAL';
|
|
1565
|
+
type PaymentMethod = 'ACH' | 'FEDWIRE' | 'SWIFT' | 'SEPA' | 'SEPA_CT' | 'CHAPS' | 'FPS' | 'RTP' | 'CARD' | 'CRYPTO_EXTERNAL' | 'CRYPTO_INTERNAL';
|
|
1566
1566
|
type OrderTypeKycRail = {
|
|
1567
1567
|
id: string;
|
|
1568
1568
|
kyc_rail_id: string;
|
package/dist/constants.d.ts
CHANGED
|
@@ -60,7 +60,9 @@ export declare enum OrderTypePaymentMethod {
|
|
|
60
60
|
CRYPTO_EXTERNAL = "CRYPTO_EXTERNAL",
|
|
61
61
|
CRYPTO_INTERNAL = "CRYPTO_INTERNAL",
|
|
62
62
|
CHAPS = "CHAPS",
|
|
63
|
-
FPS = "FPS"
|
|
63
|
+
FPS = "FPS",
|
|
64
|
+
RTP = "RTP",
|
|
65
|
+
CARD = "CARD"
|
|
64
66
|
}
|
|
65
67
|
export declare const orderTypePaymentMethodCheck: IsEnumEqualToUnion<OrderTypePaymentMethod, API.Orders.V2.OrderTypes.PaymentMethod>;
|
|
66
68
|
export type OrderTypePaymentMethodMismatch = EnumUnionMismatch<OrderTypePaymentMethod, API.Orders.V2.OrderTypes.PaymentMethod>;
|
|
@@ -137,7 +139,23 @@ export declare enum OrderType {
|
|
|
137
139
|
DLS_SEPA_ONRAMP = "DLS_SEPA_ONRAMP",
|
|
138
140
|
DLS_SEPA_OFFRAMP = "DLS_SEPA_OFFRAMP",
|
|
139
141
|
DLS_SWIFT_ONRAMP = "DLS_SWIFT_ONRAMP",
|
|
140
|
-
DLS_SWIFT_OFFRAMP = "DLS_SWIFT_OFFRAMP"
|
|
142
|
+
DLS_SWIFT_OFFRAMP = "DLS_SWIFT_OFFRAMP",
|
|
143
|
+
BC1_SEPA_ONRAMP = "BC1_SEPA_ONRAMP",
|
|
144
|
+
BC1_SEPA_OFFRAMP = "BC1_SEPA_OFFRAMP",
|
|
145
|
+
BC1_SWIFT_ONRAMP = "BC1_SWIFT_ONRAMP",
|
|
146
|
+
BC1_SWIFT_OFFRAMP = "BC1_SWIFT_OFFRAMP",
|
|
147
|
+
BC3_SEPA_ONRAMP = "BC3_SEPA_ONRAMP",
|
|
148
|
+
BC3_SEPA_OFFRAMP = "BC3_SEPA_OFFRAMP",
|
|
149
|
+
NARVI_SEPA_ONRAMP = "NARVI_SEPA_ONRAMP",
|
|
150
|
+
NARVI_SEPA_OFFRAMP = "NARVI_SEPA_OFFRAMP",
|
|
151
|
+
EXCHANGE_OMNI_ONRAMP = "EXCHANGE_OMNI_ONRAMP",
|
|
152
|
+
EXCHANGE_OMNI_OFFRAMP = "EXCHANGE_OMNI_OFFRAMP",
|
|
153
|
+
EXCHANGE_OMNI_CRYPTO = "EXCHANGE_OMNI_CRYPTO",
|
|
154
|
+
CARD_AUTHORIZATION = "CARD_AUTHORIZATION",
|
|
155
|
+
CARD_AUTH_REFUND = "CARD_AUTH_REFUND",
|
|
156
|
+
REFUND_CARD_PREPAID = "REFUND_CARD_PREPAID",
|
|
157
|
+
REFUND_CARD_SUBACCOUNT = "REFUND_CARD_SUBACCOUNT",
|
|
158
|
+
ADJUSTMENT = "ADJUSTMENT"
|
|
141
159
|
}
|
|
142
160
|
export declare enum WalletTransactionRecordType {
|
|
143
161
|
CARD_PROVIDER_DEPOSIT = "CARD_PROVIDER_DEPOSIT",
|
|
@@ -233,7 +251,23 @@ export declare enum WalletTransactionRecordType {
|
|
|
233
251
|
DLS_SEPA_ONRAMP = "DLS_SEPA_ONRAMP",
|
|
234
252
|
DLS_SEPA_OFFRAMP = "DLS_SEPA_OFFRAMP",
|
|
235
253
|
DLS_SWIFT_ONRAMP = "DLS_SWIFT_ONRAMP",
|
|
236
|
-
DLS_SWIFT_OFFRAMP = "DLS_SWIFT_OFFRAMP"
|
|
254
|
+
DLS_SWIFT_OFFRAMP = "DLS_SWIFT_OFFRAMP",
|
|
255
|
+
BC1_SEPA_ONRAMP = "BC1_SEPA_ONRAMP",
|
|
256
|
+
BC1_SEPA_OFFRAMP = "BC1_SEPA_OFFRAMP",
|
|
257
|
+
BC1_SWIFT_ONRAMP = "BC1_SWIFT_ONRAMP",
|
|
258
|
+
BC1_SWIFT_OFFRAMP = "BC1_SWIFT_OFFRAMP",
|
|
259
|
+
BC3_SEPA_ONRAMP = "BC3_SEPA_ONRAMP",
|
|
260
|
+
BC3_SEPA_OFFRAMP = "BC3_SEPA_OFFRAMP",
|
|
261
|
+
NARVI_SEPA_ONRAMP = "NARVI_SEPA_ONRAMP",
|
|
262
|
+
NARVI_SEPA_OFFRAMP = "NARVI_SEPA_OFFRAMP",
|
|
263
|
+
EXCHANGE_OMNI_ONRAMP = "EXCHANGE_OMNI_ONRAMP",
|
|
264
|
+
EXCHANGE_OMNI_OFFRAMP = "EXCHANGE_OMNI_OFFRAMP",
|
|
265
|
+
EXCHANGE_OMNI_CRYPTO = "EXCHANGE_OMNI_CRYPTO",
|
|
266
|
+
CARD_AUTHORIZATION = "CARD_AUTHORIZATION",
|
|
267
|
+
CARD_AUTH_REFUND = "CARD_AUTH_REFUND",
|
|
268
|
+
REFUND_CARD_PREPAID = "REFUND_CARD_PREPAID",
|
|
269
|
+
REFUND_CARD_SUBACCOUNT = "REFUND_CARD_SUBACCOUNT",
|
|
270
|
+
ADJUSTMENT = "ADJUSTMENT"
|
|
237
271
|
}
|
|
238
272
|
export type OrderTypeMissingInWalletTransactionRecordType = Exclude<EnumValues<OrderType>, EnumValues<WalletTransactionRecordType>>;
|
|
239
273
|
export declare const orderTypeIncludedInWalletTransactionRecordTypeCheck: IsUnionSubset<EnumValues<OrderType>, EnumValues<WalletTransactionRecordType>>;
|
|
@@ -285,6 +319,7 @@ export declare enum KYCStatuses {
|
|
|
285
319
|
PENDING = "PENDING",
|
|
286
320
|
PROCESSING = "PROCESSING",
|
|
287
321
|
HOLD = "HOLD",
|
|
322
|
+
NEEDS_ATTENTION = "NEEDS_ATTENTION",
|
|
288
323
|
DOUBLE = "DOUBLE",
|
|
289
324
|
SOFT_REJECT = "SOFT_REJECT",
|
|
290
325
|
REJECT = "REJECT",
|
|
@@ -383,8 +418,9 @@ export declare enum VirtualAccountsInstructionType {
|
|
|
383
418
|
CRYPTO_EXTERNAL = "CRYPTO_EXTERNAL",
|
|
384
419
|
CRYPTO_INTERNAL = "CRYPTO_INTERNAL"
|
|
385
420
|
}
|
|
386
|
-
|
|
387
|
-
export
|
|
421
|
+
type OrderPaymentMethodWithoutDepositInstruction = OrderTypePaymentMethod.RTP | OrderTypePaymentMethod.CARD;
|
|
422
|
+
export declare const isOrderPaymentMethodEqualWithVirtualAccountsInstructionType: IsEnumEqualToUnion<Exclude<OrderTypePaymentMethod, OrderPaymentMethodWithoutDepositInstruction>, API.VirtualAccounts.VirtualAccount.DepositInstruction.InstructionType>;
|
|
423
|
+
export type OrderPaymentMethodEqualWithVirtualAccountsInstructionTypeMismatch = EnumUnionMismatch<Exclude<OrderTypePaymentMethod, OrderPaymentMethodWithoutDepositInstruction>, API.VirtualAccounts.VirtualAccount.DepositInstruction.InstructionType>;
|
|
388
424
|
export declare const virtualAccountsInstructionTypeCheck: IsEnumEqualToUnion<VirtualAccountsInstructionType, API.VirtualAccounts.VirtualAccount.DepositInstruction.InstructionType>;
|
|
389
425
|
export type VirtualAccountsInstructionTypeMismatch = EnumUnionMismatch<VirtualAccountsInstructionType, API.VirtualAccounts.VirtualAccount.DepositInstruction.InstructionType>;
|
|
390
426
|
export declare enum CardTransactionStatus {
|
|
@@ -399,3 +435,4 @@ export declare enum CardTransactionStatus {
|
|
|
399
435
|
REVERSED = "REVERSED",
|
|
400
436
|
DECLINED = "DECLINED"
|
|
401
437
|
}
|
|
438
|
+
export {};
|
package/dist/constants.js
CHANGED
|
@@ -61,6 +61,8 @@ export var OrderTypePaymentMethod;
|
|
|
61
61
|
OrderTypePaymentMethod["CRYPTO_INTERNAL"] = "CRYPTO_INTERNAL";
|
|
62
62
|
OrderTypePaymentMethod["CHAPS"] = "CHAPS";
|
|
63
63
|
OrderTypePaymentMethod["FPS"] = "FPS";
|
|
64
|
+
OrderTypePaymentMethod["RTP"] = "RTP";
|
|
65
|
+
OrderTypePaymentMethod["CARD"] = "CARD";
|
|
64
66
|
})(OrderTypePaymentMethod || (OrderTypePaymentMethod = {}));
|
|
65
67
|
export const orderTypePaymentMethodCheck = true;
|
|
66
68
|
export var OrderType;
|
|
@@ -139,6 +141,22 @@ export var OrderType;
|
|
|
139
141
|
OrderType["DLS_SEPA_OFFRAMP"] = "DLS_SEPA_OFFRAMP";
|
|
140
142
|
OrderType["DLS_SWIFT_ONRAMP"] = "DLS_SWIFT_ONRAMP";
|
|
141
143
|
OrderType["DLS_SWIFT_OFFRAMP"] = "DLS_SWIFT_OFFRAMP";
|
|
144
|
+
OrderType["BC1_SEPA_ONRAMP"] = "BC1_SEPA_ONRAMP";
|
|
145
|
+
OrderType["BC1_SEPA_OFFRAMP"] = "BC1_SEPA_OFFRAMP";
|
|
146
|
+
OrderType["BC1_SWIFT_ONRAMP"] = "BC1_SWIFT_ONRAMP";
|
|
147
|
+
OrderType["BC1_SWIFT_OFFRAMP"] = "BC1_SWIFT_OFFRAMP";
|
|
148
|
+
OrderType["BC3_SEPA_ONRAMP"] = "BC3_SEPA_ONRAMP";
|
|
149
|
+
OrderType["BC3_SEPA_OFFRAMP"] = "BC3_SEPA_OFFRAMP";
|
|
150
|
+
OrderType["NARVI_SEPA_ONRAMP"] = "NARVI_SEPA_ONRAMP";
|
|
151
|
+
OrderType["NARVI_SEPA_OFFRAMP"] = "NARVI_SEPA_OFFRAMP";
|
|
152
|
+
OrderType["EXCHANGE_OMNI_ONRAMP"] = "EXCHANGE_OMNI_ONRAMP";
|
|
153
|
+
OrderType["EXCHANGE_OMNI_OFFRAMP"] = "EXCHANGE_OMNI_OFFRAMP";
|
|
154
|
+
OrderType["EXCHANGE_OMNI_CRYPTO"] = "EXCHANGE_OMNI_CRYPTO";
|
|
155
|
+
OrderType["CARD_AUTHORIZATION"] = "CARD_AUTHORIZATION";
|
|
156
|
+
OrderType["CARD_AUTH_REFUND"] = "CARD_AUTH_REFUND";
|
|
157
|
+
OrderType["REFUND_CARD_PREPAID"] = "REFUND_CARD_PREPAID";
|
|
158
|
+
OrderType["REFUND_CARD_SUBACCOUNT"] = "REFUND_CARD_SUBACCOUNT";
|
|
159
|
+
OrderType["ADJUSTMENT"] = "ADJUSTMENT";
|
|
142
160
|
// when extend do not forget to add new order type to the enum WalletTransactionRecordType
|
|
143
161
|
})(OrderType || (OrderType = {}));
|
|
144
162
|
export var WalletTransactionRecordType;
|
|
@@ -237,6 +255,22 @@ export var WalletTransactionRecordType;
|
|
|
237
255
|
WalletTransactionRecordType["DLS_SEPA_OFFRAMP"] = "DLS_SEPA_OFFRAMP";
|
|
238
256
|
WalletTransactionRecordType["DLS_SWIFT_ONRAMP"] = "DLS_SWIFT_ONRAMP";
|
|
239
257
|
WalletTransactionRecordType["DLS_SWIFT_OFFRAMP"] = "DLS_SWIFT_OFFRAMP";
|
|
258
|
+
WalletTransactionRecordType["BC1_SEPA_ONRAMP"] = "BC1_SEPA_ONRAMP";
|
|
259
|
+
WalletTransactionRecordType["BC1_SEPA_OFFRAMP"] = "BC1_SEPA_OFFRAMP";
|
|
260
|
+
WalletTransactionRecordType["BC1_SWIFT_ONRAMP"] = "BC1_SWIFT_ONRAMP";
|
|
261
|
+
WalletTransactionRecordType["BC1_SWIFT_OFFRAMP"] = "BC1_SWIFT_OFFRAMP";
|
|
262
|
+
WalletTransactionRecordType["BC3_SEPA_ONRAMP"] = "BC3_SEPA_ONRAMP";
|
|
263
|
+
WalletTransactionRecordType["BC3_SEPA_OFFRAMP"] = "BC3_SEPA_OFFRAMP";
|
|
264
|
+
WalletTransactionRecordType["NARVI_SEPA_ONRAMP"] = "NARVI_SEPA_ONRAMP";
|
|
265
|
+
WalletTransactionRecordType["NARVI_SEPA_OFFRAMP"] = "NARVI_SEPA_OFFRAMP";
|
|
266
|
+
WalletTransactionRecordType["EXCHANGE_OMNI_ONRAMP"] = "EXCHANGE_OMNI_ONRAMP";
|
|
267
|
+
WalletTransactionRecordType["EXCHANGE_OMNI_OFFRAMP"] = "EXCHANGE_OMNI_OFFRAMP";
|
|
268
|
+
WalletTransactionRecordType["EXCHANGE_OMNI_CRYPTO"] = "EXCHANGE_OMNI_CRYPTO";
|
|
269
|
+
WalletTransactionRecordType["CARD_AUTHORIZATION"] = "CARD_AUTHORIZATION";
|
|
270
|
+
WalletTransactionRecordType["CARD_AUTH_REFUND"] = "CARD_AUTH_REFUND";
|
|
271
|
+
WalletTransactionRecordType["REFUND_CARD_PREPAID"] = "REFUND_CARD_PREPAID";
|
|
272
|
+
WalletTransactionRecordType["REFUND_CARD_SUBACCOUNT"] = "REFUND_CARD_SUBACCOUNT";
|
|
273
|
+
WalletTransactionRecordType["ADJUSTMENT"] = "ADJUSTMENT";
|
|
240
274
|
})(WalletTransactionRecordType || (WalletTransactionRecordType = {}));
|
|
241
275
|
export const orderTypeIncludedInWalletTransactionRecordTypeCheck = true;
|
|
242
276
|
export var RequestStatus;
|
|
@@ -300,6 +334,7 @@ export var KYCStatuses;
|
|
|
300
334
|
KYCStatuses["PENDING"] = "PENDING";
|
|
301
335
|
KYCStatuses["PROCESSING"] = "PROCESSING";
|
|
302
336
|
KYCStatuses["HOLD"] = "HOLD";
|
|
337
|
+
KYCStatuses["NEEDS_ATTENTION"] = "NEEDS_ATTENTION";
|
|
303
338
|
KYCStatuses["DOUBLE"] = "DOUBLE";
|
|
304
339
|
KYCStatuses["SOFT_REJECT"] = "SOFT_REJECT";
|
|
305
340
|
KYCStatuses["REJECT"] = "REJECT";
|