valr-typescript-client 1.0.21 → 1.0.23

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/CHECKSUMS.txt CHANGED
@@ -1,22 +1,23 @@
1
1
  # Package Checksums
2
2
 
3
- Generated on: 2026-01-03 09:56:15 UTC
4
- Git commit: 34da8c1043257a02e67aac96212d578b6e285753
5
- Version: 1.0.21
3
+ Generated on: 2026-01-03 12:10:12 UTC
4
+ Git commit: 4a1243ba185663cf730db8336adeb8e03acdc4b2
5
+ Version: 1.0.23
6
6
 
7
7
  ## Distribution Files (SHA256)
8
8
 
9
- 029fa7f75839d7bf16f71a99704928208e8fcc8fd8c1096cf9c7e6075d7d455b dist/index.js.map
10
- 0af937ec53ccafc2b2ee487c264ffc5100ba80cb7437dba1bbb53532e8ba9436 dist/index.mjs.map
11
- 3275588ac5ec719891a8c35c418d25db8492e953b364409b97fe079971c9e6c1 dist/index.mjs
12
- 5f08ace6957b06df29324b3869848cbc421b53030531c8545c664f1df9cf7384 dist/index.d.mts
13
- 5f08ace6957b06df29324b3869848cbc421b53030531c8545c664f1df9cf7384 dist/index.d.ts
14
- 7e8d73467b1c57397945238dfcf370e7d7f1bd271a13eb9dd14f3612a9cf629f dist/index.js
9
+ 1ad7d8372ec293272faac50fb84b35965c3929b24d50a77423c722bc1ccef7fe dist/index.mjs.map
10
+ 3437e326103c1e4152983f727b2181f719e935ec5e6ed478df199267dc5568db dist/index.d.mts
11
+ 3437e326103c1e4152983f727b2181f719e935ec5e6ed478df199267dc5568db dist/index.d.ts
12
+ 39577c8273f8a1ca6b66e44709bf7b6c381e1b1c31755ded1ef4bc252904449a dist/index.js
13
+ 4864ea5b0f9f744caba9b4aeca007335a6c5149e73d060c9864345e19bc6da5b dist/index.js.map
14
+ 488b2a9c9dc822a4253c0250c9f7c4a5c7547e8c805dda35e9b28a1f31587c06 dist/index.mjs
15
15
 
16
16
  ## Source Files (SHA256)
17
17
 
18
18
  05cf6e982fcbd24cebc6c1b4c6e366095859cdf503eb70f5faf4d9bb9844631a src/client/ValrClient.ts
19
19
  0705454404aa0e0f2ce619615600d871c8052ac0afe495bb412219d9a6c032ac src/types/public.ts
20
+ 07451545d78e896ab106b594151b4b9a3ae5ca4a2328914b2040a67cec403270 src/types/margin.ts
20
21
  0a9bed00d1ee34300d532c01c86a300d76f51b96d50aea2ebae15750c7c06d94 src/api/account.ts
21
22
  0b4530d458e0c3bbadb79566943ef466404215e545f25c4965c72d9bfeee86dc src/api/health.ts
22
23
  13c4319ae883c96f779ea57f481c52f2298397e11950213f7d43a05290f42e8a src/api/trading.ts
@@ -24,12 +25,11 @@ Version: 1.0.21
24
25
  174ffc46347008d3f473af1916e8b1b38fb9752e68a69776df831dca676a1342 src/api/public.ts
25
26
  392124cca58a1532bd57472ba574bc065052c552ea8f10b7c675c942310c67e8 src/api/wallets.ts
26
27
  39fd4908c74bcca8c4e74a3a4e16de4439dfca781a7644ca9383c5f5096744cf src/types/futures.ts
27
- 3ff881e0a329681fecb0eae9ce178e9d1e6e4d6a6d55bfb5eec99a46c85d4e2a src/types/margin.ts
28
+ 3e5ff90a945e12f321b0e7a5bdef82f95e0b04f6ba794eeed9d4887d80d50323 src/api/pay.ts
28
29
  40f2245b2685e634bd0f531367561c1c26d174cc083c496c1f914e8c6a9f948a src/client/ValrWebSocketClient.ts
29
30
  4202fe777fda3e43ff944971783116f17031d124395e4a44cb2bf2bec5ff246c src/types/bundles.ts
30
31
  43ce3b42153a2e1a2d290ea893507c820e4461eb2162b1ccfa0d832118468618 src/api/margin.ts
31
32
  4abf3aa146557f6f33f039a03a675cb6588da94f29e885ef97458cb698699425 src/types/common.ts
32
- 5475e829a33f944dec5dd4079066aa621c76c7767ac56f172a322ce110d43f0b src/types/pay.ts
33
33
  551aa287e635dad4d0209502a0410f09c169715a5bac95366a875038c3e50504 src/api/futures.ts
34
34
  5572db3151cd4db275a7ac6e8a8859e3c9048e0bd873a113f445139c0db2017c src/api/bundles.ts
35
35
  562187bbc4b29a68add1fad7d63c73fb1345b45154358fa0276e2e224cfb7e5a src/types/account.ts
@@ -39,9 +39,9 @@ Version: 1.0.21
39
39
  6ec43e250aca38bc6a9dc4f16e5fe7e6ca25bd831270c5d02c1bc82d79f5731d src/types/loans.ts
40
40
  70636220daed500243e5cd40d25748efcd401a9ff50f4237fa200bce1fe3be38 src/errors/ValrError.ts
41
41
  84688ccf1549178fd43927028588f07d348076e4fe5681d61ea05179103c6959 src/types/trading.ts
42
- 9c02d6094465660040c390c199687b0a8200aa86eb5654c4f2077b928cf8546c src/types/index.ts
43
42
  a52c483def6de035f7fcf690b6102129ea22cb817bed5a106d3617c8edc7d849 src/api/stake.ts
44
- c4c0979b4fc9a035bcf0d1bd8b379e5e2e85c8ea39a812cb7d8cd66ba5c04494 src/api/pay.ts
43
+ dc9ef99ff3979f5dd0f0fc7231f9a6b9418dd13e0e8961511af1c9d54200576e src/types/pay.ts
44
+ ea33c7a1b695a352f19757f81304cb22dd446b12ee0ba3a58bfb31f2446bbb70 src/types/index.ts
45
45
  ec209b0ff8de8e662c2ea701feccee22b53e6ed684affb3eacd39e68c3aa725a src/index.ts
46
46
  f67a6c69ed003a1606221e792de802592aedb7164cafb7d7d2eab4fac105807a src/utils/constants.ts
47
47
  f819d431730bb51a23d2cad32cc6eee83dc9d917e5cb9efd3201ffeb64d76ec5 src/client/AccountWebSocket.ts
package/dist/index.d.mts CHANGED
@@ -1489,6 +1489,10 @@ interface FundingHistoryParams extends PaginationParams {
1489
1489
  * Margin information V1
1490
1490
  */
1491
1491
  interface MarginInfoV1 {
1492
+ /** Current margin fraction (account equity / account debt in reference) */
1493
+ marginFraction: string;
1494
+ /** Current margin fraction excluding available assets (collateralised only) */
1495
+ collateralisedMarginFraction: string;
1492
1496
  /** Initial margin fraction */
1493
1497
  initialMarginFraction: string;
1494
1498
  /** Total borrowed in reference currency */
@@ -1505,15 +1509,27 @@ interface MarginInfoV1 {
1505
1509
  maintenanceMarginFraction: string;
1506
1510
  /** Auto close margin fraction */
1507
1511
  autoCloseMarginFraction: string;
1512
+ /** Debt-to-equity ratio (inverse of margin fraction) */
1513
+ leverageMultiple: number;
1508
1514
  /** Total positions at entry in reference currency */
1509
1515
  totalPositionsAtEntryInReference: string;
1510
1516
  /** Total unrealised futures PnL in reference currency */
1511
1517
  totalUnrealisedFuturesPnlInReference: string;
1518
+ /** Default initial margin fraction */
1519
+ defaultInitialMarginFraction?: string;
1520
+ /** Default maintenance margin fraction */
1521
+ defaultMaintenanceMarginFraction?: string;
1522
+ /** Default auto close margin fraction */
1523
+ defaultAutoCloseMarginFraction?: string;
1512
1524
  }
1513
1525
  /**
1514
1526
  * Margin information V2
1515
1527
  */
1516
1528
  interface MarginInfoV2 {
1529
+ /** Current margin fraction (account equity / account positions at open value) */
1530
+ marginFraction: string;
1531
+ /** Current margin fraction excluding available assets (collateralised only) */
1532
+ collateralisedMarginFraction: string;
1517
1533
  /** Initial margin fraction */
1518
1534
  initialMarginFraction: string;
1519
1535
  /** Total leveraged exposure in reference currency */
@@ -1530,6 +1546,8 @@ interface MarginInfoV2 {
1530
1546
  maintenanceMarginFraction: string;
1531
1547
  /** Auto close margin fraction */
1532
1548
  autoCloseMarginFraction: string;
1549
+ /** Debt-to-equity ratio (inverse of margin fraction) */
1550
+ leverageMultiple: number;
1533
1551
  /** Total positions at entry in reference currency */
1534
1552
  totalPositionsAtEntryInReference: string;
1535
1553
  /** Total unrealised futures PnL in reference currency */
@@ -1821,49 +1839,127 @@ interface EarnHistoryParams {
1821
1839
  }
1822
1840
 
1823
1841
  /**
1824
- * Payment request
1842
+ * Create payment request (P2P payment within VALR)
1825
1843
  */
1826
1844
  interface CreatePaymentRequest {
1827
- /** Merchant ID */
1828
- merchantId: string;
1829
- /** Currency */
1845
+ /** Payment currency */
1830
1846
  currency: CurrencyCode;
1831
- /** Amount */
1832
- amount: string;
1833
- /** Description */
1834
- description?: string;
1835
- /** Return URL after payment */
1836
- returnUrl?: string;
1837
- /** Callback URL for payment notifications */
1838
- callbackUrl?: string;
1847
+ /** Payment amount */
1848
+ amount: number | string;
1849
+ /** Recipient's email address (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
1850
+ recipientEmail?: string;
1851
+ /** Recipient's cell number (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
1852
+ recipientCellNumber?: string;
1853
+ /** Recipient's Pay ID (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
1854
+ recipientPayId?: string;
1855
+ /** Note visible to recipient */
1856
+ recipientNote?: string;
1857
+ /** Private note for sender */
1858
+ senderNote?: string;
1859
+ /** Whether to send payment anonymously */
1860
+ anonymous?: boolean | string;
1861
+ }
1862
+ /**
1863
+ * Payment creation response
1864
+ */
1865
+ interface PaymentResponse {
1866
+ /** Unique payment identifier */
1867
+ identifier: string;
1868
+ /** Transaction ID */
1869
+ transactionId: string;
1839
1870
  }
1840
1871
  /**
1841
- * Payment
1872
+ * Payment status
1842
1873
  */
1843
- interface Payment {
1844
- /** Payment ID */
1845
- id: string;
1846
- /** Merchant ID */
1847
- merchantId: string;
1848
- /** Currency */
1849
- currency: CurrencyCode;
1850
- /** Amount */
1874
+ type PaymentStatusType = 'PENDING' | 'COMPLETE' | 'RETURNED' | 'CANCELLED';
1875
+ /**
1876
+ * Payment direction/type
1877
+ */
1878
+ type PaymentDirection = 'SEND' | 'RECEIVE';
1879
+ /**
1880
+ * Payment transaction type
1881
+ */
1882
+ type PaymentTransactionType = 'DEBIT' | 'CREDIT';
1883
+ /**
1884
+ * Payment status by transaction ID
1885
+ */
1886
+ interface PaymentStatus {
1887
+ /** Payment amount */
1851
1888
  amount: string;
1889
+ /** Transaction timestamp */
1890
+ timestamp: ISOTimestamp;
1891
+ /** Transaction ID */
1892
+ transactionId: string;
1852
1893
  /** Payment status */
1853
- status: 'PENDING' | 'COMPLETED' | 'EXPIRED' | 'CANCELLED';
1854
- /** Payment URL */
1855
- paymentUrl: string;
1856
- /** When created */
1857
- createdAt: ISOTimestamp;
1858
- /** When expires */
1859
- expiresAt: ISOTimestamp;
1860
- /** When completed */
1861
- completedAt?: ISOTimestamp;
1894
+ status: PaymentStatusType;
1895
+ /** Payment direction */
1896
+ direction: PaymentDirection;
1862
1897
  }
1863
1898
  /**
1864
- * Payment status
1899
+ * Payment details
1900
+ */
1901
+ interface PaymentDetails {
1902
+ /** Unique payment identifier */
1903
+ identifier: string;
1904
+ /** Other party identifier (email, phone, or name) */
1905
+ otherPartyIdentifier: string;
1906
+ /** Payment amount */
1907
+ amount: number;
1908
+ /** Payment status */
1909
+ status: PaymentStatusType;
1910
+ /** Transaction timestamp */
1911
+ timestamp: ISOTimestamp;
1912
+ /** Private note from sender (only visible if you're the sender) */
1913
+ senderNote?: string;
1914
+ /** Note from recipient (visible to both parties) */
1915
+ recipientNote?: string;
1916
+ /** Transaction ID */
1917
+ transactionId: string;
1918
+ /** Whether payment was anonymous */
1919
+ anonymous: boolean;
1920
+ /** Transaction type (DEBIT = sent, CREDIT = received) */
1921
+ type: PaymentTransactionType;
1922
+ }
1923
+ /**
1924
+ * Payment history item
1925
+ */
1926
+ interface PaymentHistoryItem extends PaymentDetails {
1927
+ }
1928
+ /**
1929
+ * Payment limits
1930
+ */
1931
+ interface PaymentLimits {
1932
+ /** Maximum payment amount */
1933
+ maxPaymentAmount: number;
1934
+ /** Minimum payment amount */
1935
+ minPaymentAmount: number;
1936
+ /** Currency for these limits */
1937
+ paymentCurrency: CurrencyCode;
1938
+ /** Type of limit */
1939
+ limitType: string;
1940
+ }
1941
+ /**
1942
+ * Pay ID response
1865
1943
  */
1866
- interface PaymentStatus extends Payment {
1944
+ interface PayIdResponse {
1945
+ /** User's Pay ID */
1946
+ payId: string;
1947
+ }
1948
+ /**
1949
+ * Reverse payment request
1950
+ */
1951
+ interface ReversePaymentRequest {
1952
+ /** Transaction ID to reverse */
1953
+ transactionId: string;
1954
+ }
1955
+ /**
1956
+ * Partial reverse payment request
1957
+ */
1958
+ interface PartialReversePaymentRequest {
1959
+ /** Transaction ID to partially reverse */
1960
+ transactionId: string;
1961
+ /** Amount to reverse */
1962
+ amountToReverse: string;
1867
1963
  }
1868
1964
 
1869
1965
  /**
@@ -3357,12 +3453,74 @@ declare class StakeAPI {
3357
3453
 
3358
3454
  /**
3359
3455
  * Pay API methods (requires authentication)
3456
+ * P2P payments within VALR
3360
3457
  */
3361
3458
  declare class PayAPI {
3362
3459
  private http;
3363
3460
  constructor(http: HttpClient);
3364
- createPayment(request: CreatePaymentRequest): Promise<Payment>;
3365
- getPaymentStatus(paymentId: string): Promise<PaymentStatus>;
3461
+ /**
3462
+ * Create a new P2P payment
3463
+ * POST /v1/pay
3464
+ *
3465
+ * @param request - Payment request (must specify one of: recipientEmail, recipientCellNumber, or recipientPayId)
3466
+ * @returns Payment response with identifier and transaction ID
3467
+ */
3468
+ createPayment(request: CreatePaymentRequest): Promise<PaymentResponse>;
3469
+ /**
3470
+ * Reverse a payment completely
3471
+ * PUT /v1/pay/transactionid/:transactionId/reverse
3472
+ *
3473
+ * @param transactionId - Transaction ID to reverse
3474
+ * @returns Reversal confirmation
3475
+ */
3476
+ reversePayment(transactionId: string): Promise<void>;
3477
+ /**
3478
+ * Partially reverse a payment
3479
+ * PUT /v1/pay/transactionid/:transactionId/partial-reverse
3480
+ *
3481
+ * @param transactionId - Transaction ID to partially reverse
3482
+ * @param amountToReverse - Amount to reverse
3483
+ * @returns Partial reversal confirmation
3484
+ */
3485
+ partiallyReversePayment(transactionId: string, amountToReverse: string): Promise<void>;
3486
+ /**
3487
+ * Get payment limits for a currency
3488
+ * GET /v1/pay/limits
3489
+ *
3490
+ * @param currency - Currency code (e.g., "BTC", "ZAR")
3491
+ * @returns Payment limits for the specified currency
3492
+ */
3493
+ getPaymentLimits(currency: CurrencyCode): Promise<PaymentLimits>;
3494
+ /**
3495
+ * Get your Pay ID (unique identifier for receiving payments)
3496
+ * GET /v1/pay/payid
3497
+ *
3498
+ * @returns Your Pay ID
3499
+ */
3500
+ getPayId(): Promise<PayIdResponse>;
3501
+ /**
3502
+ * Get payment history (sent and received payments)
3503
+ * GET /v1/pay/history
3504
+ *
3505
+ * @returns Array of payment history items
3506
+ */
3507
+ getPaymentHistory(): Promise<PaymentHistoryItem[]>;
3508
+ /**
3509
+ * Get payment details by identifier
3510
+ * GET /v1/pay/identifier/:identifier
3511
+ *
3512
+ * @param identifier - Payment identifier
3513
+ * @returns Payment details
3514
+ */
3515
+ getPaymentByIdentifier(identifier: string): Promise<PaymentDetails>;
3516
+ /**
3517
+ * Get payment status by transaction ID
3518
+ * GET /v1/pay/transactionid/:transactionId
3519
+ *
3520
+ * @param transactionId - Transaction ID
3521
+ * @returns Payment status
3522
+ */
3523
+ getPaymentStatus(transactionId: string): Promise<PaymentStatus>;
3366
3524
  }
3367
3525
 
3368
3526
  /**
@@ -3911,4 +4069,4 @@ declare const HEADERS: {
3911
4069
  readonly RATE_LIMITED: "x-valr-ratelimited";
3912
4070
  };
3913
4071
 
3914
- export { API_BASE_URL, AccountAPI, type AccountMarginStatus, type AccountTrade$1 as AccountTrade, AccountWebSocket, type ApiKey, type AutoBuyDepositReference, type Balance, type BalanceUpdate, type BalancesParams, type Bank, type BankAccount, type BaseOrderRequest, type BaseWebSocketMessage, type BatchOrderOperation, type BatchOrderOperationType, type BatchOrderRequest, type BatchOrderResponse, type BatchOrderResponseItem, type BatchOrderStatus, type BorrowHistoryItem, type Bundle, type BundleComposition, type BundleOrder, BundlesAPI, type BuyBundleRequest, type CancelOrderRequest, type CancelOrderRequestV2, type ChangeLoanRateRequest, type ClosedPosition, type ClosedPositionSummary, type ConditionalOrderRequest, type ConditionalOrderResponse, type ConditionalOrderStatus, type ConditionalOrderTriggerType, type ConditionalOrderType, type CreateApiKeyRequest, type CreateApiKeyResponse, type CreateLoanRequest, type CreatePaymentRequest, type CreateSubaccountRequest, type CryptoAddress, type CryptoDepositHistoryItem, type CryptoDepositHistoryParams, type CryptoWithdrawalHistoryItem, type CryptoWithdrawalHistoryParams, type CryptoWithdrawalRequest, type CryptoWithdrawalResponse, type CryptoWithdrawalStatus, type Currency, type CurrencyCode, type CurrencyPair, type CurrencyPairInfo, type CurrencyPairOrderTypes, type CursorPaginationParams, type CustomerOrderId, type DepositAddress, type EarnBalance, type EarnBalancesParams, type EarnHistoryItem, type EarnHistoryParams, type EarnHistoryType, type EarnRate, type EarnRatesParams, type EarnReward, type EarnRewardsParams, type EarnType, type EnableMarginRequest, type FiatDepositReference, type FiatWithdrawalRequest, type FiatWithdrawalResponse, type FundingHistoryParams, type FundingPayment, type FundingRateHistory, FuturesAPI, type FuturesInfo, type FuturesPosition, HEADERS, HealthAPI, type HistoricalOrderDetail, type HistoricalOrderSummary, type ISOTimestamp, type IncreaseLoanRequest, type LeverageInfo, type LeverageOption, type LimitOrderRequest, type LimitOrderRequestV2, type LinkBankAccountRequest, type LoanCreditHistoryItem, type LoanInfo, type LoanRate, LoansAPI, MarginAPI, type MarginInfoV1, type MarginInfoV2, type MarketOrderRequest, type MarketOrderRequestV2, type MarketSummary, type MarketSummaryUpdate, type ModifyConditionalOrderRequest, type ModifyOrderRequest, type ModifyOrderRequestV2, type NetworkType, type NewTrade, type OpenLoan, type OpenOrder, type OrderBook, type OrderBookEntry$1 as OrderBookEntry, type OrderBookUpdate, type OrderHistoryParams, type OrderId, type OrderProcessed, type OrderResponse, type OrderSide, type OrderStatus, type OrderStatusDetail, type OrderStatusSummary, type OrderStatusUpdate, type OrderTrade, type OrderType, type OrderTypesParams, type PaginationParams, type PairType, PayAPI, type Payment, type PaymentStatus, type PositionHistoryParams, type PostOnly, type PriceBucket, type PriceBucketsParams, type PriceQuantity, PublicAPI, RATE_LIMITS, RequestSigner, type RequestUnlockRequest, type ServerTime, type ServiceProvider, type SimpleOrderRequest, type SimpleQuoteRequest, type SimpleQuoteResponse, StakeAPI, type StakeRequest, type StopLimitOrderRequest, type StopLimitOrderRequestV2, type Subaccount, type SubaccountId, type Subscription, type SubscriptionRequest, type TimeInForce, type TimeRangeParams, type Trade, type TradeFee, type TradeHistoryParams, TradeWebSocket, TradingAPI, type Transaction, type TransactionHistoryParams, type TransactionType, type TransferRequest, type UnstakeRequest, type UpdateLeverageRequest, ValrApiError, ValrAuthenticationError, ValrClient, type ValrClientConfig, ValrConfigurationError, ValrError, ValrRateLimitError, type ValrStatus, ValrValidationError, ValrWebSocketClient, ValrWebSocketError, WS_ACCOUNT_URL_PATH, WS_BASE_URL, WS_TRADE_URL_PATH, WalletsAPI, type AccountTrade as WebSocketAccountTrade, type WebSocketClientConfig, type WebSocketMessage, type WebSocketMessageType, type WhitelistedAddress, type WithdrawalConfigInfo };
4072
+ export { API_BASE_URL, AccountAPI, type AccountMarginStatus, type AccountTrade$1 as AccountTrade, AccountWebSocket, type ApiKey, type AutoBuyDepositReference, type Balance, type BalanceUpdate, type BalancesParams, type Bank, type BankAccount, type BaseOrderRequest, type BaseWebSocketMessage, type BatchOrderOperation, type BatchOrderOperationType, type BatchOrderRequest, type BatchOrderResponse, type BatchOrderResponseItem, type BatchOrderStatus, type BorrowHistoryItem, type Bundle, type BundleComposition, type BundleOrder, BundlesAPI, type BuyBundleRequest, type CancelOrderRequest, type CancelOrderRequestV2, type ChangeLoanRateRequest, type ClosedPosition, type ClosedPositionSummary, type ConditionalOrderRequest, type ConditionalOrderResponse, type ConditionalOrderStatus, type ConditionalOrderTriggerType, type ConditionalOrderType, type CreateApiKeyRequest, type CreateApiKeyResponse, type CreateLoanRequest, type CreatePaymentRequest, type CreateSubaccountRequest, type CryptoAddress, type CryptoDepositHistoryItem, type CryptoDepositHistoryParams, type CryptoWithdrawalHistoryItem, type CryptoWithdrawalHistoryParams, type CryptoWithdrawalRequest, type CryptoWithdrawalResponse, type CryptoWithdrawalStatus, type Currency, type CurrencyCode, type CurrencyPair, type CurrencyPairInfo, type CurrencyPairOrderTypes, type CursorPaginationParams, type CustomerOrderId, type DepositAddress, type EarnBalance, type EarnBalancesParams, type EarnHistoryItem, type EarnHistoryParams, type EarnHistoryType, type EarnRate, type EarnRatesParams, type EarnReward, type EarnRewardsParams, type EarnType, type EnableMarginRequest, type FiatDepositReference, type FiatWithdrawalRequest, type FiatWithdrawalResponse, type FundingHistoryParams, type FundingPayment, type FundingRateHistory, FuturesAPI, type FuturesInfo, type FuturesPosition, HEADERS, HealthAPI, type HistoricalOrderDetail, type HistoricalOrderSummary, type ISOTimestamp, type IncreaseLoanRequest, type LeverageInfo, type LeverageOption, type LimitOrderRequest, type LimitOrderRequestV2, type LinkBankAccountRequest, type LoanCreditHistoryItem, type LoanInfo, type LoanRate, LoansAPI, MarginAPI, type MarginInfoV1, type MarginInfoV2, type MarketOrderRequest, type MarketOrderRequestV2, type MarketSummary, type MarketSummaryUpdate, type ModifyConditionalOrderRequest, type ModifyOrderRequest, type ModifyOrderRequestV2, type NetworkType, type NewTrade, type OpenLoan, type OpenOrder, type OrderBook, type OrderBookEntry$1 as OrderBookEntry, type OrderBookUpdate, type OrderHistoryParams, type OrderId, type OrderProcessed, type OrderResponse, type OrderSide, type OrderStatus, type OrderStatusDetail, type OrderStatusSummary, type OrderStatusUpdate, type OrderTrade, type OrderType, type OrderTypesParams, type PaginationParams, type PairType, type PartialReversePaymentRequest, PayAPI, type PayIdResponse, type PaymentDetails, type PaymentDirection, type PaymentHistoryItem, type PaymentLimits, type PaymentResponse, type PaymentStatus, type PaymentStatusType, type PaymentTransactionType, type PositionHistoryParams, type PostOnly, type PriceBucket, type PriceBucketsParams, type PriceQuantity, PublicAPI, RATE_LIMITS, RequestSigner, type RequestUnlockRequest, type ReversePaymentRequest, type ServerTime, type ServiceProvider, type SimpleOrderRequest, type SimpleQuoteRequest, type SimpleQuoteResponse, StakeAPI, type StakeRequest, type StopLimitOrderRequest, type StopLimitOrderRequestV2, type Subaccount, type SubaccountId, type Subscription, type SubscriptionRequest, type TimeInForce, type TimeRangeParams, type Trade, type TradeFee, type TradeHistoryParams, TradeWebSocket, TradingAPI, type Transaction, type TransactionHistoryParams, type TransactionType, type TransferRequest, type UnstakeRequest, type UpdateLeverageRequest, ValrApiError, ValrAuthenticationError, ValrClient, type ValrClientConfig, ValrConfigurationError, ValrError, ValrRateLimitError, type ValrStatus, ValrValidationError, ValrWebSocketClient, ValrWebSocketError, WS_ACCOUNT_URL_PATH, WS_BASE_URL, WS_TRADE_URL_PATH, WalletsAPI, type AccountTrade as WebSocketAccountTrade, type WebSocketClientConfig, type WebSocketMessage, type WebSocketMessageType, type WhitelistedAddress, type WithdrawalConfigInfo };
package/dist/index.d.ts CHANGED
@@ -1489,6 +1489,10 @@ interface FundingHistoryParams extends PaginationParams {
1489
1489
  * Margin information V1
1490
1490
  */
1491
1491
  interface MarginInfoV1 {
1492
+ /** Current margin fraction (account equity / account debt in reference) */
1493
+ marginFraction: string;
1494
+ /** Current margin fraction excluding available assets (collateralised only) */
1495
+ collateralisedMarginFraction: string;
1492
1496
  /** Initial margin fraction */
1493
1497
  initialMarginFraction: string;
1494
1498
  /** Total borrowed in reference currency */
@@ -1505,15 +1509,27 @@ interface MarginInfoV1 {
1505
1509
  maintenanceMarginFraction: string;
1506
1510
  /** Auto close margin fraction */
1507
1511
  autoCloseMarginFraction: string;
1512
+ /** Debt-to-equity ratio (inverse of margin fraction) */
1513
+ leverageMultiple: number;
1508
1514
  /** Total positions at entry in reference currency */
1509
1515
  totalPositionsAtEntryInReference: string;
1510
1516
  /** Total unrealised futures PnL in reference currency */
1511
1517
  totalUnrealisedFuturesPnlInReference: string;
1518
+ /** Default initial margin fraction */
1519
+ defaultInitialMarginFraction?: string;
1520
+ /** Default maintenance margin fraction */
1521
+ defaultMaintenanceMarginFraction?: string;
1522
+ /** Default auto close margin fraction */
1523
+ defaultAutoCloseMarginFraction?: string;
1512
1524
  }
1513
1525
  /**
1514
1526
  * Margin information V2
1515
1527
  */
1516
1528
  interface MarginInfoV2 {
1529
+ /** Current margin fraction (account equity / account positions at open value) */
1530
+ marginFraction: string;
1531
+ /** Current margin fraction excluding available assets (collateralised only) */
1532
+ collateralisedMarginFraction: string;
1517
1533
  /** Initial margin fraction */
1518
1534
  initialMarginFraction: string;
1519
1535
  /** Total leveraged exposure in reference currency */
@@ -1530,6 +1546,8 @@ interface MarginInfoV2 {
1530
1546
  maintenanceMarginFraction: string;
1531
1547
  /** Auto close margin fraction */
1532
1548
  autoCloseMarginFraction: string;
1549
+ /** Debt-to-equity ratio (inverse of margin fraction) */
1550
+ leverageMultiple: number;
1533
1551
  /** Total positions at entry in reference currency */
1534
1552
  totalPositionsAtEntryInReference: string;
1535
1553
  /** Total unrealised futures PnL in reference currency */
@@ -1821,49 +1839,127 @@ interface EarnHistoryParams {
1821
1839
  }
1822
1840
 
1823
1841
  /**
1824
- * Payment request
1842
+ * Create payment request (P2P payment within VALR)
1825
1843
  */
1826
1844
  interface CreatePaymentRequest {
1827
- /** Merchant ID */
1828
- merchantId: string;
1829
- /** Currency */
1845
+ /** Payment currency */
1830
1846
  currency: CurrencyCode;
1831
- /** Amount */
1832
- amount: string;
1833
- /** Description */
1834
- description?: string;
1835
- /** Return URL after payment */
1836
- returnUrl?: string;
1837
- /** Callback URL for payment notifications */
1838
- callbackUrl?: string;
1847
+ /** Payment amount */
1848
+ amount: number | string;
1849
+ /** Recipient's email address (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
1850
+ recipientEmail?: string;
1851
+ /** Recipient's cell number (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
1852
+ recipientCellNumber?: string;
1853
+ /** Recipient's Pay ID (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
1854
+ recipientPayId?: string;
1855
+ /** Note visible to recipient */
1856
+ recipientNote?: string;
1857
+ /** Private note for sender */
1858
+ senderNote?: string;
1859
+ /** Whether to send payment anonymously */
1860
+ anonymous?: boolean | string;
1861
+ }
1862
+ /**
1863
+ * Payment creation response
1864
+ */
1865
+ interface PaymentResponse {
1866
+ /** Unique payment identifier */
1867
+ identifier: string;
1868
+ /** Transaction ID */
1869
+ transactionId: string;
1839
1870
  }
1840
1871
  /**
1841
- * Payment
1872
+ * Payment status
1842
1873
  */
1843
- interface Payment {
1844
- /** Payment ID */
1845
- id: string;
1846
- /** Merchant ID */
1847
- merchantId: string;
1848
- /** Currency */
1849
- currency: CurrencyCode;
1850
- /** Amount */
1874
+ type PaymentStatusType = 'PENDING' | 'COMPLETE' | 'RETURNED' | 'CANCELLED';
1875
+ /**
1876
+ * Payment direction/type
1877
+ */
1878
+ type PaymentDirection = 'SEND' | 'RECEIVE';
1879
+ /**
1880
+ * Payment transaction type
1881
+ */
1882
+ type PaymentTransactionType = 'DEBIT' | 'CREDIT';
1883
+ /**
1884
+ * Payment status by transaction ID
1885
+ */
1886
+ interface PaymentStatus {
1887
+ /** Payment amount */
1851
1888
  amount: string;
1889
+ /** Transaction timestamp */
1890
+ timestamp: ISOTimestamp;
1891
+ /** Transaction ID */
1892
+ transactionId: string;
1852
1893
  /** Payment status */
1853
- status: 'PENDING' | 'COMPLETED' | 'EXPIRED' | 'CANCELLED';
1854
- /** Payment URL */
1855
- paymentUrl: string;
1856
- /** When created */
1857
- createdAt: ISOTimestamp;
1858
- /** When expires */
1859
- expiresAt: ISOTimestamp;
1860
- /** When completed */
1861
- completedAt?: ISOTimestamp;
1894
+ status: PaymentStatusType;
1895
+ /** Payment direction */
1896
+ direction: PaymentDirection;
1862
1897
  }
1863
1898
  /**
1864
- * Payment status
1899
+ * Payment details
1900
+ */
1901
+ interface PaymentDetails {
1902
+ /** Unique payment identifier */
1903
+ identifier: string;
1904
+ /** Other party identifier (email, phone, or name) */
1905
+ otherPartyIdentifier: string;
1906
+ /** Payment amount */
1907
+ amount: number;
1908
+ /** Payment status */
1909
+ status: PaymentStatusType;
1910
+ /** Transaction timestamp */
1911
+ timestamp: ISOTimestamp;
1912
+ /** Private note from sender (only visible if you're the sender) */
1913
+ senderNote?: string;
1914
+ /** Note from recipient (visible to both parties) */
1915
+ recipientNote?: string;
1916
+ /** Transaction ID */
1917
+ transactionId: string;
1918
+ /** Whether payment was anonymous */
1919
+ anonymous: boolean;
1920
+ /** Transaction type (DEBIT = sent, CREDIT = received) */
1921
+ type: PaymentTransactionType;
1922
+ }
1923
+ /**
1924
+ * Payment history item
1925
+ */
1926
+ interface PaymentHistoryItem extends PaymentDetails {
1927
+ }
1928
+ /**
1929
+ * Payment limits
1930
+ */
1931
+ interface PaymentLimits {
1932
+ /** Maximum payment amount */
1933
+ maxPaymentAmount: number;
1934
+ /** Minimum payment amount */
1935
+ minPaymentAmount: number;
1936
+ /** Currency for these limits */
1937
+ paymentCurrency: CurrencyCode;
1938
+ /** Type of limit */
1939
+ limitType: string;
1940
+ }
1941
+ /**
1942
+ * Pay ID response
1865
1943
  */
1866
- interface PaymentStatus extends Payment {
1944
+ interface PayIdResponse {
1945
+ /** User's Pay ID */
1946
+ payId: string;
1947
+ }
1948
+ /**
1949
+ * Reverse payment request
1950
+ */
1951
+ interface ReversePaymentRequest {
1952
+ /** Transaction ID to reverse */
1953
+ transactionId: string;
1954
+ }
1955
+ /**
1956
+ * Partial reverse payment request
1957
+ */
1958
+ interface PartialReversePaymentRequest {
1959
+ /** Transaction ID to partially reverse */
1960
+ transactionId: string;
1961
+ /** Amount to reverse */
1962
+ amountToReverse: string;
1867
1963
  }
1868
1964
 
1869
1965
  /**
@@ -3357,12 +3453,74 @@ declare class StakeAPI {
3357
3453
 
3358
3454
  /**
3359
3455
  * Pay API methods (requires authentication)
3456
+ * P2P payments within VALR
3360
3457
  */
3361
3458
  declare class PayAPI {
3362
3459
  private http;
3363
3460
  constructor(http: HttpClient);
3364
- createPayment(request: CreatePaymentRequest): Promise<Payment>;
3365
- getPaymentStatus(paymentId: string): Promise<PaymentStatus>;
3461
+ /**
3462
+ * Create a new P2P payment
3463
+ * POST /v1/pay
3464
+ *
3465
+ * @param request - Payment request (must specify one of: recipientEmail, recipientCellNumber, or recipientPayId)
3466
+ * @returns Payment response with identifier and transaction ID
3467
+ */
3468
+ createPayment(request: CreatePaymentRequest): Promise<PaymentResponse>;
3469
+ /**
3470
+ * Reverse a payment completely
3471
+ * PUT /v1/pay/transactionid/:transactionId/reverse
3472
+ *
3473
+ * @param transactionId - Transaction ID to reverse
3474
+ * @returns Reversal confirmation
3475
+ */
3476
+ reversePayment(transactionId: string): Promise<void>;
3477
+ /**
3478
+ * Partially reverse a payment
3479
+ * PUT /v1/pay/transactionid/:transactionId/partial-reverse
3480
+ *
3481
+ * @param transactionId - Transaction ID to partially reverse
3482
+ * @param amountToReverse - Amount to reverse
3483
+ * @returns Partial reversal confirmation
3484
+ */
3485
+ partiallyReversePayment(transactionId: string, amountToReverse: string): Promise<void>;
3486
+ /**
3487
+ * Get payment limits for a currency
3488
+ * GET /v1/pay/limits
3489
+ *
3490
+ * @param currency - Currency code (e.g., "BTC", "ZAR")
3491
+ * @returns Payment limits for the specified currency
3492
+ */
3493
+ getPaymentLimits(currency: CurrencyCode): Promise<PaymentLimits>;
3494
+ /**
3495
+ * Get your Pay ID (unique identifier for receiving payments)
3496
+ * GET /v1/pay/payid
3497
+ *
3498
+ * @returns Your Pay ID
3499
+ */
3500
+ getPayId(): Promise<PayIdResponse>;
3501
+ /**
3502
+ * Get payment history (sent and received payments)
3503
+ * GET /v1/pay/history
3504
+ *
3505
+ * @returns Array of payment history items
3506
+ */
3507
+ getPaymentHistory(): Promise<PaymentHistoryItem[]>;
3508
+ /**
3509
+ * Get payment details by identifier
3510
+ * GET /v1/pay/identifier/:identifier
3511
+ *
3512
+ * @param identifier - Payment identifier
3513
+ * @returns Payment details
3514
+ */
3515
+ getPaymentByIdentifier(identifier: string): Promise<PaymentDetails>;
3516
+ /**
3517
+ * Get payment status by transaction ID
3518
+ * GET /v1/pay/transactionid/:transactionId
3519
+ *
3520
+ * @param transactionId - Transaction ID
3521
+ * @returns Payment status
3522
+ */
3523
+ getPaymentStatus(transactionId: string): Promise<PaymentStatus>;
3366
3524
  }
3367
3525
 
3368
3526
  /**
@@ -3911,4 +4069,4 @@ declare const HEADERS: {
3911
4069
  readonly RATE_LIMITED: "x-valr-ratelimited";
3912
4070
  };
3913
4071
 
3914
- export { API_BASE_URL, AccountAPI, type AccountMarginStatus, type AccountTrade$1 as AccountTrade, AccountWebSocket, type ApiKey, type AutoBuyDepositReference, type Balance, type BalanceUpdate, type BalancesParams, type Bank, type BankAccount, type BaseOrderRequest, type BaseWebSocketMessage, type BatchOrderOperation, type BatchOrderOperationType, type BatchOrderRequest, type BatchOrderResponse, type BatchOrderResponseItem, type BatchOrderStatus, type BorrowHistoryItem, type Bundle, type BundleComposition, type BundleOrder, BundlesAPI, type BuyBundleRequest, type CancelOrderRequest, type CancelOrderRequestV2, type ChangeLoanRateRequest, type ClosedPosition, type ClosedPositionSummary, type ConditionalOrderRequest, type ConditionalOrderResponse, type ConditionalOrderStatus, type ConditionalOrderTriggerType, type ConditionalOrderType, type CreateApiKeyRequest, type CreateApiKeyResponse, type CreateLoanRequest, type CreatePaymentRequest, type CreateSubaccountRequest, type CryptoAddress, type CryptoDepositHistoryItem, type CryptoDepositHistoryParams, type CryptoWithdrawalHistoryItem, type CryptoWithdrawalHistoryParams, type CryptoWithdrawalRequest, type CryptoWithdrawalResponse, type CryptoWithdrawalStatus, type Currency, type CurrencyCode, type CurrencyPair, type CurrencyPairInfo, type CurrencyPairOrderTypes, type CursorPaginationParams, type CustomerOrderId, type DepositAddress, type EarnBalance, type EarnBalancesParams, type EarnHistoryItem, type EarnHistoryParams, type EarnHistoryType, type EarnRate, type EarnRatesParams, type EarnReward, type EarnRewardsParams, type EarnType, type EnableMarginRequest, type FiatDepositReference, type FiatWithdrawalRequest, type FiatWithdrawalResponse, type FundingHistoryParams, type FundingPayment, type FundingRateHistory, FuturesAPI, type FuturesInfo, type FuturesPosition, HEADERS, HealthAPI, type HistoricalOrderDetail, type HistoricalOrderSummary, type ISOTimestamp, type IncreaseLoanRequest, type LeverageInfo, type LeverageOption, type LimitOrderRequest, type LimitOrderRequestV2, type LinkBankAccountRequest, type LoanCreditHistoryItem, type LoanInfo, type LoanRate, LoansAPI, MarginAPI, type MarginInfoV1, type MarginInfoV2, type MarketOrderRequest, type MarketOrderRequestV2, type MarketSummary, type MarketSummaryUpdate, type ModifyConditionalOrderRequest, type ModifyOrderRequest, type ModifyOrderRequestV2, type NetworkType, type NewTrade, type OpenLoan, type OpenOrder, type OrderBook, type OrderBookEntry$1 as OrderBookEntry, type OrderBookUpdate, type OrderHistoryParams, type OrderId, type OrderProcessed, type OrderResponse, type OrderSide, type OrderStatus, type OrderStatusDetail, type OrderStatusSummary, type OrderStatusUpdate, type OrderTrade, type OrderType, type OrderTypesParams, type PaginationParams, type PairType, PayAPI, type Payment, type PaymentStatus, type PositionHistoryParams, type PostOnly, type PriceBucket, type PriceBucketsParams, type PriceQuantity, PublicAPI, RATE_LIMITS, RequestSigner, type RequestUnlockRequest, type ServerTime, type ServiceProvider, type SimpleOrderRequest, type SimpleQuoteRequest, type SimpleQuoteResponse, StakeAPI, type StakeRequest, type StopLimitOrderRequest, type StopLimitOrderRequestV2, type Subaccount, type SubaccountId, type Subscription, type SubscriptionRequest, type TimeInForce, type TimeRangeParams, type Trade, type TradeFee, type TradeHistoryParams, TradeWebSocket, TradingAPI, type Transaction, type TransactionHistoryParams, type TransactionType, type TransferRequest, type UnstakeRequest, type UpdateLeverageRequest, ValrApiError, ValrAuthenticationError, ValrClient, type ValrClientConfig, ValrConfigurationError, ValrError, ValrRateLimitError, type ValrStatus, ValrValidationError, ValrWebSocketClient, ValrWebSocketError, WS_ACCOUNT_URL_PATH, WS_BASE_URL, WS_TRADE_URL_PATH, WalletsAPI, type AccountTrade as WebSocketAccountTrade, type WebSocketClientConfig, type WebSocketMessage, type WebSocketMessageType, type WhitelistedAddress, type WithdrawalConfigInfo };
4072
+ export { API_BASE_URL, AccountAPI, type AccountMarginStatus, type AccountTrade$1 as AccountTrade, AccountWebSocket, type ApiKey, type AutoBuyDepositReference, type Balance, type BalanceUpdate, type BalancesParams, type Bank, type BankAccount, type BaseOrderRequest, type BaseWebSocketMessage, type BatchOrderOperation, type BatchOrderOperationType, type BatchOrderRequest, type BatchOrderResponse, type BatchOrderResponseItem, type BatchOrderStatus, type BorrowHistoryItem, type Bundle, type BundleComposition, type BundleOrder, BundlesAPI, type BuyBundleRequest, type CancelOrderRequest, type CancelOrderRequestV2, type ChangeLoanRateRequest, type ClosedPosition, type ClosedPositionSummary, type ConditionalOrderRequest, type ConditionalOrderResponse, type ConditionalOrderStatus, type ConditionalOrderTriggerType, type ConditionalOrderType, type CreateApiKeyRequest, type CreateApiKeyResponse, type CreateLoanRequest, type CreatePaymentRequest, type CreateSubaccountRequest, type CryptoAddress, type CryptoDepositHistoryItem, type CryptoDepositHistoryParams, type CryptoWithdrawalHistoryItem, type CryptoWithdrawalHistoryParams, type CryptoWithdrawalRequest, type CryptoWithdrawalResponse, type CryptoWithdrawalStatus, type Currency, type CurrencyCode, type CurrencyPair, type CurrencyPairInfo, type CurrencyPairOrderTypes, type CursorPaginationParams, type CustomerOrderId, type DepositAddress, type EarnBalance, type EarnBalancesParams, type EarnHistoryItem, type EarnHistoryParams, type EarnHistoryType, type EarnRate, type EarnRatesParams, type EarnReward, type EarnRewardsParams, type EarnType, type EnableMarginRequest, type FiatDepositReference, type FiatWithdrawalRequest, type FiatWithdrawalResponse, type FundingHistoryParams, type FundingPayment, type FundingRateHistory, FuturesAPI, type FuturesInfo, type FuturesPosition, HEADERS, HealthAPI, type HistoricalOrderDetail, type HistoricalOrderSummary, type ISOTimestamp, type IncreaseLoanRequest, type LeverageInfo, type LeverageOption, type LimitOrderRequest, type LimitOrderRequestV2, type LinkBankAccountRequest, type LoanCreditHistoryItem, type LoanInfo, type LoanRate, LoansAPI, MarginAPI, type MarginInfoV1, type MarginInfoV2, type MarketOrderRequest, type MarketOrderRequestV2, type MarketSummary, type MarketSummaryUpdate, type ModifyConditionalOrderRequest, type ModifyOrderRequest, type ModifyOrderRequestV2, type NetworkType, type NewTrade, type OpenLoan, type OpenOrder, type OrderBook, type OrderBookEntry$1 as OrderBookEntry, type OrderBookUpdate, type OrderHistoryParams, type OrderId, type OrderProcessed, type OrderResponse, type OrderSide, type OrderStatus, type OrderStatusDetail, type OrderStatusSummary, type OrderStatusUpdate, type OrderTrade, type OrderType, type OrderTypesParams, type PaginationParams, type PairType, type PartialReversePaymentRequest, PayAPI, type PayIdResponse, type PaymentDetails, type PaymentDirection, type PaymentHistoryItem, type PaymentLimits, type PaymentResponse, type PaymentStatus, type PaymentStatusType, type PaymentTransactionType, type PositionHistoryParams, type PostOnly, type PriceBucket, type PriceBucketsParams, type PriceQuantity, PublicAPI, RATE_LIMITS, RequestSigner, type RequestUnlockRequest, type ReversePaymentRequest, type ServerTime, type ServiceProvider, type SimpleOrderRequest, type SimpleQuoteRequest, type SimpleQuoteResponse, StakeAPI, type StakeRequest, type StopLimitOrderRequest, type StopLimitOrderRequestV2, type Subaccount, type SubaccountId, type Subscription, type SubscriptionRequest, type TimeInForce, type TimeRangeParams, type Trade, type TradeFee, type TradeHistoryParams, TradeWebSocket, TradingAPI, type Transaction, type TransactionHistoryParams, type TransactionType, type TransferRequest, type UnstakeRequest, type UpdateLeverageRequest, ValrApiError, ValrAuthenticationError, ValrClient, type ValrClientConfig, ValrConfigurationError, ValrError, ValrRateLimitError, type ValrStatus, ValrValidationError, ValrWebSocketClient, ValrWebSocketError, WS_ACCOUNT_URL_PATH, WS_BASE_URL, WS_TRADE_URL_PATH, WalletsAPI, type AccountTrade as WebSocketAccountTrade, type WebSocketClientConfig, type WebSocketMessage, type WebSocketMessageType, type WhitelistedAddress, type WithdrawalConfigInfo };