squarefi-bff-api-module 1.36.91 → 1.36.92
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 +36 -8
- package/dist/api/types/autogen/apiV1Frontend.types.d.ts +37 -9
- package/dist/api/types/autogen/apiV1Tenant.types.d.ts +74 -9
- package/dist/api/types/autogen/apiV2.types.d.ts +17 -0
- package/dist/api/types/types.d.ts +2 -0
- package/package.json +1 -1
|
@@ -5138,8 +5138,10 @@ export interface paths {
|
|
|
5138
5138
|
* status NEW can be approved. Orders
|
|
5139
5139
|
* created with `scheduled_at` move to EXPECTED instead — no funds are
|
|
5140
5140
|
* debited until execution at the requested time.
|
|
5141
|
-
* A scheduled order is approved only
|
|
5142
|
-
*
|
|
5141
|
+
* A scheduled order is approved only inside its `approval_window`: an
|
|
5142
|
+
* earlier approve answers 400 `SCHEDULED_APPROVAL_NOT_OPEN` with
|
|
5143
|
+
* `details.approvable_from`; once `scheduled_at` is less than one hour
|
|
5144
|
+
* away, 400 `SCHEDULED_AT_TOO_SOON`
|
|
5143
5145
|
* (create the payment again with a new date).
|
|
5144
5146
|
*
|
|
5145
5147
|
*/
|
|
@@ -5168,7 +5170,7 @@ export interface paths {
|
|
|
5168
5170
|
};
|
|
5169
5171
|
};
|
|
5170
5172
|
};
|
|
5171
|
-
/** @description Insufficient funds (`INSUFFICIENT_FUNDS` — the order is released back to NEW), a scheduled order less than an hour before its `scheduled_at` (`SCHEDULED_AT_TOO_SOON`), or validation error */
|
|
5173
|
+
/** @description Insufficient funds (`INSUFFICIENT_FUNDS` — the order is released back to NEW), a scheduled order before its approval window opens (`SCHEDULED_APPROVAL_NOT_OPEN`, `details.approvable_from`) or less than an hour before its `scheduled_at` (`SCHEDULED_AT_TOO_SOON`), or validation error */
|
|
5172
5174
|
400: {
|
|
5173
5175
|
headers: {
|
|
5174
5176
|
[name: string]: unknown;
|
|
@@ -5361,7 +5363,7 @@ export interface paths {
|
|
|
5361
5363
|
note?: string;
|
|
5362
5364
|
/**
|
|
5363
5365
|
* Format: date-time
|
|
5364
|
-
* @description Optional. Schedule the transfer for a future time (min 1 hour, max
|
|
5366
|
+
* @description Optional. Schedule the transfer for a future time (min 1 hour, max 30 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically, once. If the balance does not cover it then, it fails with `scheduled_failure.code` INSUFFICIENT_FUNDS and is not retried. Approve inside the `approval_window` of the order (from the order signature lifetime minus 1 hour before scheduled_at until 1 hour before it); a draft not approved by then is canceled.
|
|
5365
5367
|
* @example 2026-07-20T12:00:00Z
|
|
5366
5368
|
*/
|
|
5367
5369
|
scheduled_at?: string;
|
|
@@ -8564,21 +8566,47 @@ export interface components {
|
|
|
8564
8566
|
id?: string;
|
|
8565
8567
|
name?: string | null;
|
|
8566
8568
|
} | null;
|
|
8569
|
+
/** @description Who created the order — for a scheduled payment, who scheduled it (pair it with `created_at`). Null when no user of the tenant created it: an API key, an operator, the system, or a legacy order with no creation record. Returned by the order list and the single-order reads. */
|
|
8570
|
+
created_by?: {
|
|
8571
|
+
/**
|
|
8572
|
+
* Format: uuid
|
|
8573
|
+
* @description User id of the author.
|
|
8574
|
+
*/
|
|
8575
|
+
id: string;
|
|
8576
|
+
/**
|
|
8577
|
+
* @description First and last name from the profile; null when it has neither.
|
|
8578
|
+
* @example Jane Brown
|
|
8579
|
+
*/
|
|
8580
|
+
name: string | null;
|
|
8581
|
+
} | null;
|
|
8567
8582
|
/**
|
|
8568
8583
|
* Format: date-time
|
|
8569
8584
|
* @description Requested execution time for scheduled payments (status EXPECTED); null for immediate orders
|
|
8570
8585
|
*/
|
|
8571
8586
|
scheduled_at?: string | null;
|
|
8572
|
-
/** @description Why a scheduled payment failed — set on a scheduled order in `FAILED`, null on any other scheduled order, absent on an immediate one. A scheduled payment is attempted once and never retried: `INSUFFICIENT_FUNDS` means nothing was debited and the payment can be created again; `PROVIDER_ERROR` — the payment was debited and the provider side failed; `EXECUTION_ERROR` — any other reason. */
|
|
8587
|
+
/** @description Why a scheduled payment failed — set on a scheduled order in `FAILED`, and on one in `CANCELED` that was never approved (`NOT_APPROVED`); null on any other scheduled order, absent on an immediate one. A scheduled payment is attempted once and never retried: `INSUFFICIENT_FUNDS` means nothing was debited and the payment can be created again; `PROVIDER_ERROR` — the payment was debited and the provider side failed; `EXECUTION_ERROR` — any other reason; `NOT_APPROVED` — the draft was not approved before its approval window closed and was canceled, nothing was debited. */
|
|
8573
8588
|
scheduled_failure?: {
|
|
8574
8589
|
/** @enum {string} */
|
|
8575
|
-
code: "INSUFFICIENT_FUNDS" | "PROVIDER_ERROR" | "EXECUTION_ERROR";
|
|
8590
|
+
code: "INSUFFICIENT_FUNDS" | "PROVIDER_ERROR" | "EXECUTION_ERROR" | "NOT_APPROVED";
|
|
8576
8591
|
/**
|
|
8577
8592
|
* @description Customer-facing text of the code.
|
|
8578
8593
|
* @example The balance was insufficient at the scheduled time.
|
|
8579
8594
|
*/
|
|
8580
8595
|
message: string;
|
|
8581
8596
|
} | null;
|
|
8597
|
+
/** @description When a scheduled payment draft can be approved — set on a scheduled order in `NEW`, null on any other scheduled order, absent on an immediate one. Approve before `opens_at` returns 400 `SCHEDULED_APPROVAL_NOT_OPEN`, after `closes_at` 400 `SCHEDULED_AT_TOO_SOON`; a draft still unapproved when the window closes is canceled (`scheduled_failure.code` `NOT_APPROVED`). The window follows the order signature lifetime, so it can move when that setting changes. */
|
|
8598
|
+
approval_window?: {
|
|
8599
|
+
/**
|
|
8600
|
+
* Format: date-time
|
|
8601
|
+
* @description From this moment the draft can be approved.
|
|
8602
|
+
*/
|
|
8603
|
+
opens_at: string;
|
|
8604
|
+
/**
|
|
8605
|
+
* Format: date-time
|
|
8606
|
+
* @description Last moment to approve: 1 hour before `scheduled_at`.
|
|
8607
|
+
*/
|
|
8608
|
+
closes_at: string;
|
|
8609
|
+
} | null;
|
|
8582
8610
|
/** Format: date-time */
|
|
8583
8611
|
created_at?: string;
|
|
8584
8612
|
/** Format: date-time */
|
|
@@ -8630,7 +8658,7 @@ export interface components {
|
|
|
8630
8658
|
note?: string;
|
|
8631
8659
|
/**
|
|
8632
8660
|
* Format: date-time
|
|
8633
|
-
* @description Optional. Schedule the payment for a future time (min 1 hour, max
|
|
8661
|
+
* @description Optional. Schedule the payment for a future time (min 1 hour, max 30 days ahead). No funds are reserved; after approval the order waits in `EXPECTED` status and executes automatically at the requested time, once: the balance is checked then, and if it does not cover the payment the order fails with `scheduled_failure.code` `INSUFFICIENT_FUNDS` and is not retried. Approve inside the `approval_window` of the order: from `opens_at` (the order signature lifetime minus 1 hour before `scheduled_at`) until 1 hour before `scheduled_at`; a draft not approved by then is canceled.
|
|
8634
8662
|
* @example 2026-07-20T12:00:00Z
|
|
8635
8663
|
*/
|
|
8636
8664
|
scheduled_at?: string;
|
|
@@ -8682,7 +8710,7 @@ export interface components {
|
|
|
8682
8710
|
note?: string;
|
|
8683
8711
|
/**
|
|
8684
8712
|
* Format: date-time
|
|
8685
|
-
* @description Optional. Schedule the payment for a future time (min 1 hour, max
|
|
8713
|
+
* @description Optional. Schedule the payment for a future time (min 1 hour, max 30 days ahead). No funds are reserved; after approval the order waits in `EXPECTED` status and executes automatically at the requested time, once: the balance is checked then, and if it does not cover the payment the order fails with `scheduled_failure.code` `INSUFFICIENT_FUNDS` and is not retried. Approve inside the `approval_window` of the order: from `opens_at` (the order signature lifetime minus 1 hour before `scheduled_at`) until 1 hour before `scheduled_at`; a draft not approved by then is canceled.
|
|
8686
8714
|
* @example 2026-07-20T12:00:00Z
|
|
8687
8715
|
*/
|
|
8688
8716
|
scheduled_at?: string;
|
|
@@ -8683,7 +8683,7 @@ export interface paths {
|
|
|
8683
8683
|
is_reverse?: boolean;
|
|
8684
8684
|
/**
|
|
8685
8685
|
* Format: date-time
|
|
8686
|
-
* @description Optional. Schedule the transfer for a future time (min 1 hour, max
|
|
8686
|
+
* @description Optional. Schedule the transfer for a future time (min 1 hour, max 30 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically, once. If the balance does not cover it then, it fails with `scheduled_failure.code` INSUFFICIENT_FUNDS and is not retried. Approve inside the `approval_window` of the order (from the order signature lifetime minus 1 hour before scheduled_at until 1 hour before it); a draft not approved by then is canceled.
|
|
8687
8687
|
*/
|
|
8688
8688
|
scheduled_at?: string;
|
|
8689
8689
|
/** @description Optional supporting documents persisted with the order. */
|
|
@@ -9356,8 +9356,10 @@ export interface paths {
|
|
|
9356
9356
|
* (request the OTP for the order being approved). Orders created with
|
|
9357
9357
|
* `scheduled_at` move to EXPECTED instead — no funds are debited until
|
|
9358
9358
|
* execution at the requested time.
|
|
9359
|
-
* A scheduled order is approved only
|
|
9360
|
-
*
|
|
9359
|
+
* A scheduled order is approved only inside its `approval_window`: an
|
|
9360
|
+
* earlier approve answers 400 `SCHEDULED_APPROVAL_NOT_OPEN` with
|
|
9361
|
+
* `details.approvable_from`; once `scheduled_at` is less than one hour
|
|
9362
|
+
* away, 400 `SCHEDULED_AT_TOO_SOON`
|
|
9361
9363
|
* (create the payment again with a new date).
|
|
9362
9364
|
*
|
|
9363
9365
|
*/
|
|
@@ -9392,7 +9394,7 @@ export interface paths {
|
|
|
9392
9394
|
};
|
|
9393
9395
|
};
|
|
9394
9396
|
};
|
|
9395
|
-
/** @description Insufficient funds (`INSUFFICIENT_FUNDS` — the order is released back to NEW), a scheduled order less than an hour before its `scheduled_at` (`SCHEDULED_AT_TOO_SOON`), or validation error */
|
|
9397
|
+
/** @description Insufficient funds (`INSUFFICIENT_FUNDS` — the order is released back to NEW), a scheduled order before its approval window opens (`SCHEDULED_APPROVAL_NOT_OPEN`, `details.approvable_from`) or less than an hour before its `scheduled_at` (`SCHEDULED_AT_TOO_SOON`), or validation error */
|
|
9396
9398
|
400: {
|
|
9397
9399
|
headers: {
|
|
9398
9400
|
[name: string]: unknown;
|
|
@@ -17585,21 +17587,47 @@ export interface components {
|
|
|
17585
17587
|
/** @description Batch name — null only when the batch can no longer be resolved. */
|
|
17586
17588
|
name?: string | null;
|
|
17587
17589
|
} | null;
|
|
17590
|
+
/** @description Who created the order — for a scheduled payment, who scheduled it (pair it with `created_at`). Null when no user of the tenant created it: an API key, an operator, the system, or a legacy order with no creation record. Returned by the order list and the single-order reads. */
|
|
17591
|
+
created_by?: {
|
|
17592
|
+
/**
|
|
17593
|
+
* Format: uuid
|
|
17594
|
+
* @description User id of the author.
|
|
17595
|
+
*/
|
|
17596
|
+
id: string;
|
|
17597
|
+
/**
|
|
17598
|
+
* @description First and last name from the profile; null when it has neither.
|
|
17599
|
+
* @example Jane Brown
|
|
17600
|
+
*/
|
|
17601
|
+
name: string | null;
|
|
17602
|
+
} | null;
|
|
17588
17603
|
/**
|
|
17589
17604
|
* Format: date-time
|
|
17590
17605
|
* @description Requested execution time for scheduled payments (status EXPECTED); null for immediate orders
|
|
17591
17606
|
*/
|
|
17592
17607
|
scheduled_at?: string | null;
|
|
17593
|
-
/** @description Why a scheduled payment failed — set on a scheduled order in `FAILED`, null on any other scheduled order, absent on an immediate one. A scheduled payment is attempted once and never retried: `INSUFFICIENT_FUNDS` means nothing was debited and the payment can be created again; `PROVIDER_ERROR` — the payment was debited and the provider side failed; `EXECUTION_ERROR` — any other reason. */
|
|
17608
|
+
/** @description Why a scheduled payment failed — set on a scheduled order in `FAILED`, and on one in `CANCELED` that was never approved (`NOT_APPROVED`); null on any other scheduled order, absent on an immediate one. A scheduled payment is attempted once and never retried: `INSUFFICIENT_FUNDS` means nothing was debited and the payment can be created again; `PROVIDER_ERROR` — the payment was debited and the provider side failed; `EXECUTION_ERROR` — any other reason; `NOT_APPROVED` — the draft was not approved before its approval window closed and was canceled, nothing was debited. */
|
|
17594
17609
|
scheduled_failure?: {
|
|
17595
17610
|
/** @enum {string} */
|
|
17596
|
-
code: "INSUFFICIENT_FUNDS" | "PROVIDER_ERROR" | "EXECUTION_ERROR";
|
|
17611
|
+
code: "INSUFFICIENT_FUNDS" | "PROVIDER_ERROR" | "EXECUTION_ERROR" | "NOT_APPROVED";
|
|
17597
17612
|
/**
|
|
17598
17613
|
* @description Customer-facing text of the code.
|
|
17599
17614
|
* @example The balance was insufficient at the scheduled time.
|
|
17600
17615
|
*/
|
|
17601
17616
|
message: string;
|
|
17602
17617
|
} | null;
|
|
17618
|
+
/** @description When a scheduled payment draft can be approved — set on a scheduled order in `NEW`, null on any other scheduled order, absent on an immediate one. Approve before `opens_at` returns 400 `SCHEDULED_APPROVAL_NOT_OPEN`, after `closes_at` 400 `SCHEDULED_AT_TOO_SOON`; a draft still unapproved when the window closes is canceled (`scheduled_failure.code` `NOT_APPROVED`). The window follows the order signature lifetime, so it can move when that setting changes. */
|
|
17619
|
+
approval_window?: {
|
|
17620
|
+
/**
|
|
17621
|
+
* Format: date-time
|
|
17622
|
+
* @description From this moment the draft can be approved.
|
|
17623
|
+
*/
|
|
17624
|
+
opens_at: string;
|
|
17625
|
+
/**
|
|
17626
|
+
* Format: date-time
|
|
17627
|
+
* @description Last moment to approve: 1 hour before `scheduled_at`.
|
|
17628
|
+
*/
|
|
17629
|
+
closes_at: string;
|
|
17630
|
+
} | null;
|
|
17603
17631
|
/** Format: date-time */
|
|
17604
17632
|
created_at: string;
|
|
17605
17633
|
/** Format: date-time */
|
|
@@ -17749,7 +17777,7 @@ export interface components {
|
|
|
17749
17777
|
note?: string;
|
|
17750
17778
|
/**
|
|
17751
17779
|
* Format: date-time
|
|
17752
|
-
* @description Optional. Schedule the payment for a future time (min 1 hour, max
|
|
17780
|
+
* @description Optional. Schedule the payment for a future time (min 1 hour, max 30 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically, once: if the balance does not cover it then, it fails with `scheduled_failure.code` INSUFFICIENT_FUNDS and is not retried. Approve inside the `approval_window` of the order: from `opens_at` (the order signature lifetime minus 1 hour before scheduled_at) until 1 hour before scheduled_at; a draft not approved by then is canceled.
|
|
17753
17781
|
*/
|
|
17754
17782
|
scheduled_at?: string;
|
|
17755
17783
|
/** @description Optional supporting documents persisted with the order. */
|
|
@@ -17780,7 +17808,7 @@ export interface components {
|
|
|
17780
17808
|
note?: string;
|
|
17781
17809
|
/**
|
|
17782
17810
|
* Format: date-time
|
|
17783
|
-
* @description Optional. Schedule the payment for a future time (min 1 hour, max
|
|
17811
|
+
* @description Optional. Schedule the payment for a future time (min 1 hour, max 30 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically, once: if the balance does not cover it then, it fails with `scheduled_failure.code` INSUFFICIENT_FUNDS and is not retried. Approve inside the `approval_window` of the order: from `opens_at` (the order signature lifetime minus 1 hour before scheduled_at) until 1 hour before scheduled_at; a draft not approved by then is canceled.
|
|
17784
17812
|
*/
|
|
17785
17813
|
scheduled_at?: string;
|
|
17786
17814
|
/** @description Optional supporting documents persisted with the order. */
|
|
@@ -18473,7 +18501,7 @@ export interface components {
|
|
|
18473
18501
|
/** Format: uuid */
|
|
18474
18502
|
id: string;
|
|
18475
18503
|
/** @enum {string} */
|
|
18476
|
-
type: "DEPOSIT_RECEIVED" | "DEPOSIT_NOT_ACCEPTED" | "TRANSFER_RECEIVED" | "ORDER_STATUS_CHANGED" | "KYC_STATUS_CHANGED" | "ANNOUNCEMENT" | "SYSTEM_MESSAGE" | "MASS_PAYOUT_STATUS_CHANGED" | "CARD_OTP" | "RFI_REQUESTED" | "RFI_RESOLVED" | "REPORT_READY" | "SCHEDULED_PAYMENT_REMINDER" | "SCHEDULED_PAYMENT_LOW_BALANCE";
|
|
18504
|
+
type: "DEPOSIT_RECEIVED" | "DEPOSIT_NOT_ACCEPTED" | "TRANSFER_RECEIVED" | "ORDER_STATUS_CHANGED" | "KYC_STATUS_CHANGED" | "ANNOUNCEMENT" | "SYSTEM_MESSAGE" | "MASS_PAYOUT_STATUS_CHANGED" | "CARD_OTP" | "RFI_REQUESTED" | "RFI_RESOLVED" | "REPORT_READY" | "SCHEDULED_PAYMENT_REMINDER" | "SCHEDULED_PAYMENT_LOW_BALANCE" | "SCHEDULED_PAYMENT_APPROVAL_REQUIRED";
|
|
18477
18505
|
/** @description Structured fact snapshot; the client renders the presentation. Shape depends on `type`; evolution is additive-only. */
|
|
18478
18506
|
payload: Record<string, never>;
|
|
18479
18507
|
/** Format: uuid */
|
|
@@ -1563,6 +1563,11 @@ export interface paths {
|
|
|
1563
1563
|
middle_name?: string;
|
|
1564
1564
|
/** Format: date */
|
|
1565
1565
|
date_of_birth?: string;
|
|
1566
|
+
/**
|
|
1567
|
+
* @description Gender of an individual as reported by the verification
|
|
1568
|
+
* @enum {string|null}
|
|
1569
|
+
*/
|
|
1570
|
+
gender?: "M" | "F" | null;
|
|
1566
1571
|
/** @description ISO 3166-1 alpha-3 country code */
|
|
1567
1572
|
nationality?: string;
|
|
1568
1573
|
country_of_birth?: string;
|
|
@@ -1737,6 +1742,11 @@ export interface paths {
|
|
|
1737
1742
|
middle_name?: string;
|
|
1738
1743
|
/** Format: date */
|
|
1739
1744
|
date_of_birth?: string;
|
|
1745
|
+
/**
|
|
1746
|
+
* @description Gender of an individual as reported by the verification
|
|
1747
|
+
* @enum {string|null}
|
|
1748
|
+
*/
|
|
1749
|
+
gender?: "M" | "F" | null;
|
|
1740
1750
|
nationality?: string;
|
|
1741
1751
|
country_of_birth?: string;
|
|
1742
1752
|
occupation?: string;
|
|
@@ -2698,7 +2708,7 @@ export interface paths {
|
|
|
2698
2708
|
note?: string;
|
|
2699
2709
|
/**
|
|
2700
2710
|
* Format: date-time
|
|
2701
|
-
* @description Optional. Schedule the transfer for a future time (min 1 hour, max
|
|
2711
|
+
* @description Optional. Schedule the transfer for a future time (min 1 hour, max 30 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically, once. If the balance does not cover it then, it fails with `scheduled_failure.code` INSUFFICIENT_FUNDS and is not retried. Approve inside the `approval_window` of the order (from the order signature lifetime minus 1 hour before scheduled_at until 1 hour before it); a draft not approved by then is canceled.
|
|
2702
2712
|
*/
|
|
2703
2713
|
scheduled_at?: string;
|
|
2704
2714
|
documents?: Record<string, never>[];
|
|
@@ -3584,8 +3594,10 @@ export interface paths {
|
|
|
3584
3594
|
* status NEW can be approved. Orders
|
|
3585
3595
|
* created with `scheduled_at` move to EXPECTED instead — no funds are
|
|
3586
3596
|
* debited until execution at the requested time.
|
|
3587
|
-
* A scheduled order is approved only
|
|
3588
|
-
*
|
|
3597
|
+
* A scheduled order is approved only inside its `approval_window`: an
|
|
3598
|
+
* earlier approve answers 400 `SCHEDULED_APPROVAL_NOT_OPEN` with
|
|
3599
|
+
* `details.approvable_from`; once `scheduled_at` is less than one hour
|
|
3600
|
+
* away, 400 `SCHEDULED_AT_TOO_SOON`
|
|
3589
3601
|
* (create the payment again with a new date).
|
|
3590
3602
|
*
|
|
3591
3603
|
*/
|
|
@@ -3614,7 +3626,7 @@ export interface paths {
|
|
|
3614
3626
|
};
|
|
3615
3627
|
};
|
|
3616
3628
|
};
|
|
3617
|
-
/** @description Insufficient funds (`INSUFFICIENT_FUNDS` — the order is released back to NEW), a scheduled order less than an hour before its `scheduled_at` (`SCHEDULED_AT_TOO_SOON`), or validation error */
|
|
3629
|
+
/** @description Insufficient funds (`INSUFFICIENT_FUNDS` — the order is released back to NEW), a scheduled order before its approval window opens (`SCHEDULED_APPROVAL_NOT_OPEN`, `details.approvable_from`) or less than an hour before its `scheduled_at` (`SCHEDULED_AT_TOO_SOON`), or validation error */
|
|
3618
3630
|
400: {
|
|
3619
3631
|
headers: {
|
|
3620
3632
|
[name: string]: unknown;
|
|
@@ -8849,7 +8861,7 @@ export interface components {
|
|
|
8849
8861
|
/** Format: date-time */
|
|
8850
8862
|
updated_at?: string;
|
|
8851
8863
|
};
|
|
8852
|
-
/** @description Documents to file for the KYC entity. Each entry is stored as a document of its type; an earlier document of the same type stays on record (several documents of one type are allowed). All entries of one request form one batch in the given order, so a multi-file document (e.g. the pages of a bank statement) is sent as several entries of the same type in one request. A document is removed through DELETE /admin/kyc_entity/{entity_id}/documents/{document_id}. */
|
|
8864
|
+
/** @description Documents to file for the KYC entity. Each entry is stored as a document of its type; an earlier document of the same type stays on record (several documents of one type are allowed). All entries of one request form one batch in the given order, so a multi-file document (e.g. the pages of a bank statement) is sent as several entries of the same type in one request. A file already on record under its type is not filed again and keeps its dates; to change them, remove the document and file it again. A document is removed through DELETE /admin/kyc_entity/{entity_id}/documents/{document_id}. */
|
|
8853
8865
|
KycDocumentsInput: {
|
|
8854
8866
|
/**
|
|
8855
8867
|
* @description Document type: supplementary, gov_id_front, gov_id_back, gov_id_hand_hold, selfie, proof_of_address, auth_letter, formation_doc, proof_of_ownership, certificate_of_registration_doc, business_registration_doc, share_structure, constitution_or_annual_report, articles_of_association, ubo_declaration, partnership_mins_of_meeting, partnership_deed, certificate_of_incumbency, regulatory_license, state_registry_doc, good_standing_cert, business_proof_of_address, invoices, contracts, financial_statements, source_of_funds, business_bank_statement, source_of_wealth_ubo, customer_supplier_agreements.
|
|
@@ -8861,6 +8873,18 @@ export interface components {
|
|
|
8861
8873
|
* @description http(s) URL of the file.
|
|
8862
8874
|
*/
|
|
8863
8875
|
link: string;
|
|
8876
|
+
/**
|
|
8877
|
+
* Format: date
|
|
8878
|
+
* @description Issue date printed on the document (`YYYY-MM-DD`), when it has one.
|
|
8879
|
+
* @example 2020-01-15
|
|
8880
|
+
*/
|
|
8881
|
+
issuance_date?: string | null;
|
|
8882
|
+
/**
|
|
8883
|
+
* Format: date
|
|
8884
|
+
* @description Expiry date printed on the document (`YYYY-MM-DD`), when it has one.
|
|
8885
|
+
* @example 2030-01-14
|
|
8886
|
+
*/
|
|
8887
|
+
expiration_date?: string | null;
|
|
8864
8888
|
}[];
|
|
8865
8889
|
KycEntity: {
|
|
8866
8890
|
/** Format: uuid */
|
|
@@ -8878,6 +8902,11 @@ export interface components {
|
|
|
8878
8902
|
middle_name?: string | null;
|
|
8879
8903
|
/** Format: date-time */
|
|
8880
8904
|
date_of_birth?: string | null;
|
|
8905
|
+
/**
|
|
8906
|
+
* @description Gender of an individual as reported by the verification — the form the cardholder endpoints take. Null when unknown.
|
|
8907
|
+
* @enum {string|null}
|
|
8908
|
+
*/
|
|
8909
|
+
gender?: "M" | "F" | null;
|
|
8881
8910
|
nationality?: string | null;
|
|
8882
8911
|
country_of_birth?: string | null;
|
|
8883
8912
|
occupation?: string | null;
|
|
@@ -8912,6 +8941,16 @@ export interface components {
|
|
|
8912
8941
|
type?: string;
|
|
8913
8942
|
/** Format: uri */
|
|
8914
8943
|
link?: string;
|
|
8944
|
+
/**
|
|
8945
|
+
* Format: date
|
|
8946
|
+
* @description Issue date printed on the document (`YYYY-MM-DD`); null when it has none or it is unknown. For an identity document this is the issue date the cardholder endpoints take — read it off the newest `gov_id_front` entry (the list is oldest first).
|
|
8947
|
+
*/
|
|
8948
|
+
issuance_date?: string | null;
|
|
8949
|
+
/**
|
|
8950
|
+
* Format: date
|
|
8951
|
+
* @description Expiry date printed on the document (`YYYY-MM-DD`); null when it has none or it is unknown. For an identity document this is the expiry date the cardholder endpoints take — read it off the newest `gov_id_front` entry (the list is oldest first).
|
|
8952
|
+
*/
|
|
8953
|
+
expiration_date?: string | null;
|
|
8915
8954
|
/**
|
|
8916
8955
|
* Format: uuid
|
|
8917
8956
|
* @description Beneficial owner the document belongs to; null for the entity itself.
|
|
@@ -9328,7 +9367,7 @@ export interface components {
|
|
|
9328
9367
|
note?: string;
|
|
9329
9368
|
/**
|
|
9330
9369
|
* Format: date-time
|
|
9331
|
-
* @description Optional. Schedule the payment for a future time (min 1 hour, max
|
|
9370
|
+
* @description Optional. Schedule the payment for a future time (min 1 hour, max 30 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically, once: if the balance does not cover it then, it fails with `scheduled_failure.code` INSUFFICIENT_FUNDS and is not retried. Approve inside the `approval_window` of the order: from `opens_at` (the order signature lifetime minus 1 hour before scheduled_at) until 1 hour before scheduled_at; a draft not approved by then is canceled.
|
|
9332
9371
|
*/
|
|
9333
9372
|
scheduled_at?: string;
|
|
9334
9373
|
};
|
|
@@ -9357,7 +9396,7 @@ export interface components {
|
|
|
9357
9396
|
note?: string;
|
|
9358
9397
|
/**
|
|
9359
9398
|
* Format: date-time
|
|
9360
|
-
* @description Optional. Schedule the payment for a future time (min 1 hour, max
|
|
9399
|
+
* @description Optional. Schedule the payment for a future time (min 1 hour, max 30 days ahead). No funds are reserved; after approval the order waits in EXPECTED status and executes automatically, once: if the balance does not cover it then, it fails with `scheduled_failure.code` INSUFFICIENT_FUNDS and is not retried. Approve inside the `approval_window` of the order: from `opens_at` (the order signature lifetime minus 1 hour before scheduled_at) until 1 hour before scheduled_at; a draft not approved by then is canceled.
|
|
9361
9400
|
*/
|
|
9362
9401
|
scheduled_at?: string;
|
|
9363
9402
|
};
|
|
@@ -9409,21 +9448,47 @@ export interface components {
|
|
|
9409
9448
|
id?: string;
|
|
9410
9449
|
name?: string | null;
|
|
9411
9450
|
} | null;
|
|
9451
|
+
/** @description Who created the order — for a scheduled payment, who scheduled it (pair it with `created_at`). Null when no user of the tenant created it: an API key, an operator, the system, or a legacy order with no creation record. Returned by the order list and the single-order reads. */
|
|
9452
|
+
created_by?: {
|
|
9453
|
+
/**
|
|
9454
|
+
* Format: uuid
|
|
9455
|
+
* @description User id of the author.
|
|
9456
|
+
*/
|
|
9457
|
+
id: string;
|
|
9458
|
+
/**
|
|
9459
|
+
* @description First and last name from the profile; null when it has neither.
|
|
9460
|
+
* @example Jane Brown
|
|
9461
|
+
*/
|
|
9462
|
+
name: string | null;
|
|
9463
|
+
} | null;
|
|
9412
9464
|
/**
|
|
9413
9465
|
* Format: date-time
|
|
9414
9466
|
* @description Requested execution time for scheduled payments (status EXPECTED); null for immediate orders
|
|
9415
9467
|
*/
|
|
9416
9468
|
scheduled_at?: string | null;
|
|
9417
|
-
/** @description Why a scheduled payment failed — set on a scheduled order in `FAILED`, null on any other scheduled order, absent on an immediate one. A scheduled payment is attempted once and never retried: `INSUFFICIENT_FUNDS` means nothing was debited and the payment can be created again; `PROVIDER_ERROR` — the payment was debited and the provider side failed; `EXECUTION_ERROR` — any other reason. */
|
|
9469
|
+
/** @description Why a scheduled payment failed — set on a scheduled order in `FAILED`, and on one in `CANCELED` that was never approved (`NOT_APPROVED`); null on any other scheduled order, absent on an immediate one. A scheduled payment is attempted once and never retried: `INSUFFICIENT_FUNDS` means nothing was debited and the payment can be created again; `PROVIDER_ERROR` — the payment was debited and the provider side failed; `EXECUTION_ERROR` — any other reason; `NOT_APPROVED` — the draft was not approved before its approval window closed and was canceled, nothing was debited. */
|
|
9418
9470
|
scheduled_failure?: {
|
|
9419
9471
|
/** @enum {string} */
|
|
9420
|
-
code: "INSUFFICIENT_FUNDS" | "PROVIDER_ERROR" | "EXECUTION_ERROR";
|
|
9472
|
+
code: "INSUFFICIENT_FUNDS" | "PROVIDER_ERROR" | "EXECUTION_ERROR" | "NOT_APPROVED";
|
|
9421
9473
|
/**
|
|
9422
9474
|
* @description Customer-facing text of the code.
|
|
9423
9475
|
* @example The balance was insufficient at the scheduled time.
|
|
9424
9476
|
*/
|
|
9425
9477
|
message: string;
|
|
9426
9478
|
} | null;
|
|
9479
|
+
/** @description When a scheduled payment draft can be approved — set on a scheduled order in `NEW`, null on any other scheduled order, absent on an immediate one. Approve before `opens_at` returns 400 `SCHEDULED_APPROVAL_NOT_OPEN`, after `closes_at` 400 `SCHEDULED_AT_TOO_SOON`; a draft still unapproved when the window closes is canceled (`scheduled_failure.code` `NOT_APPROVED`). The window follows the order signature lifetime, so it can move when that setting changes. */
|
|
9480
|
+
approval_window?: {
|
|
9481
|
+
/**
|
|
9482
|
+
* Format: date-time
|
|
9483
|
+
* @description From this moment the draft can be approved.
|
|
9484
|
+
*/
|
|
9485
|
+
opens_at: string;
|
|
9486
|
+
/**
|
|
9487
|
+
* Format: date-time
|
|
9488
|
+
* @description Last moment to approve: 1 hour before `scheduled_at`.
|
|
9489
|
+
*/
|
|
9490
|
+
closes_at: string;
|
|
9491
|
+
} | null;
|
|
9427
9492
|
/** Format: date-time */
|
|
9428
9493
|
created_at?: string;
|
|
9429
9494
|
/** Format: date-time */
|
|
@@ -1604,6 +1604,18 @@ export interface components {
|
|
|
1604
1604
|
type: "supplementary" | "gov_id_front" | "gov_id_back" | "gov_id_hand_hold" | "selfie" | "proof_of_address" | "auth_letter" | "formation_doc" | "proof_of_ownership" | "certificate_of_registration_doc" | "business_registration_doc" | "share_structure" | "constitution_or_annual_report" | "articles_of_association" | "ubo_declaration" | "partnership_mins_of_meeting" | "partnership_deed" | "certificate_of_incumbency" | "regulatory_license" | "state_registry_doc" | "good_standing_cert" | "business_proof_of_address" | "invoices" | "contracts" | "financial_statements" | "source_of_funds" | "business_bank_statement" | "source_of_wealth_ubo" | "customer_supplier_agreements";
|
|
1605
1605
|
/** Format: uri */
|
|
1606
1606
|
link: string;
|
|
1607
|
+
/**
|
|
1608
|
+
* Format: date
|
|
1609
|
+
* @description Issue date printed on the document (YYYY-MM-DD), when it has one.
|
|
1610
|
+
* @example 2020-01-15
|
|
1611
|
+
*/
|
|
1612
|
+
issuance_date?: Record<string, never> | null;
|
|
1613
|
+
/**
|
|
1614
|
+
* Format: date
|
|
1615
|
+
* @description Expiry date printed on the document (YYYY-MM-DD), when it has one.
|
|
1616
|
+
* @example 2030-01-14
|
|
1617
|
+
*/
|
|
1618
|
+
expiration_date?: Record<string, never> | null;
|
|
1607
1619
|
/** @example bff */
|
|
1608
1620
|
readonly source?: string;
|
|
1609
1621
|
/**
|
|
@@ -1688,6 +1700,11 @@ export interface components {
|
|
|
1688
1700
|
/** @default false */
|
|
1689
1701
|
dao_status: boolean | null;
|
|
1690
1702
|
date_of_birth?: string | null;
|
|
1703
|
+
/**
|
|
1704
|
+
* @description Gender of an individual as the KYC provider reports it: M or F; null when unknown.
|
|
1705
|
+
* @enum {string|null}
|
|
1706
|
+
*/
|
|
1707
|
+
gender?: "M" | "F" | null;
|
|
1691
1708
|
due_diligence_form?: components["schemas"]["KycEntityDueDiligenceFormEntity"] | null;
|
|
1692
1709
|
email?: string | null;
|
|
1693
1710
|
export_country?: string | null;
|
|
@@ -2702,6 +2702,8 @@ export declare namespace API {
|
|
|
2702
2702
|
type Order = componentsV1Frontend['schemas']['Order'];
|
|
2703
2703
|
type ScheduledFailure = NonNullable<Order['scheduled_failure']>;
|
|
2704
2704
|
type ScheduledFailureCode = ScheduledFailure['code'];
|
|
2705
|
+
type ApprovalWindow = NonNullable<Order['approval_window']>;
|
|
2706
|
+
type OrderAuthor = NonNullable<Order['created_by']>;
|
|
2705
2707
|
type OrderEnvelope = {
|
|
2706
2708
|
success?: boolean;
|
|
2707
2709
|
data?: Order;
|