valr-typescript-client 1.0.21 → 1.0.22

package/CHECKSUMS.txt

@@ -1,17 +1,17 @@
 # Package Checksums
 
-Generated on: 2026-01-03 09:56:15 UTC
-Git commit: 34da8c1043257a02e67aac96212d578b6e285753
-Version: 1.0.21
+Generated on: 2026-01-03 10:18:39 UTC
+Git commit: 8dcbf4a37dd0fe8555eedfe091d0c342ed07c4dc
+Version: 1.0.22
 
 ## Distribution Files (SHA256)
 
-029fa7f75839d7bf16f71a99704928208e8fcc8fd8c1096cf9c7e6075d7d455b  dist/index.js.map
-0af937ec53ccafc2b2ee487c264ffc5100ba80cb7437dba1bbb53532e8ba9436  dist/index.mjs.map
-3275588ac5ec719891a8c35c418d25db8492e953b364409b97fe079971c9e6c1  dist/index.mjs
-5f08ace6957b06df29324b3869848cbc421b53030531c8545c664f1df9cf7384  dist/index.d.mts
-5f08ace6957b06df29324b3869848cbc421b53030531c8545c664f1df9cf7384  dist/index.d.ts
-7e8d73467b1c57397945238dfcf370e7d7f1bd271a13eb9dd14f3612a9cf629f  dist/index.js
+1ad7d8372ec293272faac50fb84b35965c3929b24d50a77423c722bc1ccef7fe  dist/index.mjs.map
+39577c8273f8a1ca6b66e44709bf7b6c381e1b1c31755ded1ef4bc252904449a  dist/index.js
+4864ea5b0f9f744caba9b4aeca007335a6c5149e73d060c9864345e19bc6da5b  dist/index.js.map
+488b2a9c9dc822a4253c0250c9f7c4a5c7547e8c805dda35e9b28a1f31587c06  dist/index.mjs
+4e70e0d9ae5ba14eeda706acb5c28eb1e770d914319ae2f48940f337b9aced59  dist/index.d.mts
+4e70e0d9ae5ba14eeda706acb5c28eb1e770d914319ae2f48940f337b9aced59  dist/index.d.ts
 
 ## Source Files (SHA256)
 
@@ -24,12 +24,12 @@ Version: 1.0.21
 174ffc46347008d3f473af1916e8b1b38fb9752e68a69776df831dca676a1342  src/api/public.ts
 392124cca58a1532bd57472ba574bc065052c552ea8f10b7c675c942310c67e8  src/api/wallets.ts
 39fd4908c74bcca8c4e74a3a4e16de4439dfca781a7644ca9383c5f5096744cf  src/types/futures.ts
+3e5ff90a945e12f321b0e7a5bdef82f95e0b04f6ba794eeed9d4887d80d50323  src/api/pay.ts
 3ff881e0a329681fecb0eae9ce178e9d1e6e4d6a6d55bfb5eec99a46c85d4e2a  src/types/margin.ts
 40f2245b2685e634bd0f531367561c1c26d174cc083c496c1f914e8c6a9f948a  src/client/ValrWebSocketClient.ts
 4202fe777fda3e43ff944971783116f17031d124395e4a44cb2bf2bec5ff246c  src/types/bundles.ts
 43ce3b42153a2e1a2d290ea893507c820e4461eb2162b1ccfa0d832118468618  src/api/margin.ts
 4abf3aa146557f6f33f039a03a675cb6588da94f29e885ef97458cb698699425  src/types/common.ts
-5475e829a33f944dec5dd4079066aa621c76c7767ac56f172a322ce110d43f0b  src/types/pay.ts
 551aa287e635dad4d0209502a0410f09c169715a5bac95366a875038c3e50504  src/api/futures.ts
 5572db3151cd4db275a7ac6e8a8859e3c9048e0bd873a113f445139c0db2017c  src/api/bundles.ts
 562187bbc4b29a68add1fad7d63c73fb1345b45154358fa0276e2e224cfb7e5a  src/types/account.ts
@@ -39,9 +39,9 @@ Version: 1.0.21
 6ec43e250aca38bc6a9dc4f16e5fe7e6ca25bd831270c5d02c1bc82d79f5731d  src/types/loans.ts
 70636220daed500243e5cd40d25748efcd401a9ff50f4237fa200bce1fe3be38  src/errors/ValrError.ts
 84688ccf1549178fd43927028588f07d348076e4fe5681d61ea05179103c6959  src/types/trading.ts
-9c02d6094465660040c390c199687b0a8200aa86eb5654c4f2077b928cf8546c  src/types/index.ts
 a52c483def6de035f7fcf690b6102129ea22cb817bed5a106d3617c8edc7d849  src/api/stake.ts
-c4c0979b4fc9a035bcf0d1bd8b379e5e2e85c8ea39a812cb7d8cd66ba5c04494  src/api/pay.ts
+dc9ef99ff3979f5dd0f0fc7231f9a6b9418dd13e0e8961511af1c9d54200576e  src/types/pay.ts
+ea33c7a1b695a352f19757f81304cb22dd446b12ee0ba3a58bfb31f2446bbb70  src/types/index.ts
 ec209b0ff8de8e662c2ea701feccee22b53e6ed684affb3eacd39e68c3aa725a  src/index.ts
 f67a6c69ed003a1606221e792de802592aedb7164cafb7d7d2eab4fac105807a  src/utils/constants.ts
 f819d431730bb51a23d2cad32cc6eee83dc9d917e5cb9efd3201ffeb64d76ec5  src/client/AccountWebSocket.ts

package/dist/index.d.mts

@@ -1821,49 +1821,127 @@ interface EarnHistoryParams {
 }
 
 /**
- * Payment request
+ * Create payment request (P2P payment within VALR)
  */
 interface CreatePaymentRequest {
-    /** Merchant ID */
-    merchantId: string;
-    /** Currency */
+    /** Payment currency */
     currency: CurrencyCode;
-    /** Amount */
-    amount: string;
-    /** Description */
-    description?: string;
-    /** Return URL after payment */
-    returnUrl?: string;
-    /** Callback URL for payment notifications */
-    callbackUrl?: string;
+    /** Payment amount */
+    amount: number | string;
+    /** Recipient's email address (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
+    recipientEmail?: string;
+    /** Recipient's cell number (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
+    recipientCellNumber?: string;
+    /** Recipient's Pay ID (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
+    recipientPayId?: string;
+    /** Note visible to recipient */
+    recipientNote?: string;
+    /** Private note for sender */
+    senderNote?: string;
+    /** Whether to send payment anonymously */
+    anonymous?: boolean | string;
+}
+/**
+ * Payment creation response
+ */
+interface PaymentResponse {
+    /** Unique payment identifier */
+    identifier: string;
+    /** Transaction ID */
+    transactionId: string;
 }
 /**
- * Payment
+ * Payment status
  */
-interface Payment {
-    /** Payment ID */
-    id: string;
-    /** Merchant ID */
-    merchantId: string;
-    /** Currency */
-    currency: CurrencyCode;
-    /** Amount */
+type PaymentStatusType = 'PENDING' | 'COMPLETE' | 'RETURNED' | 'CANCELLED';
+/**
+ * Payment direction/type
+ */
+type PaymentDirection = 'SEND' | 'RECEIVE';
+/**
+ * Payment transaction type
+ */
+type PaymentTransactionType = 'DEBIT' | 'CREDIT';
+/**
+ * Payment status by transaction ID
+ */
+interface PaymentStatus {
+    /** Payment amount */
     amount: string;
+    /** Transaction timestamp */
+    timestamp: ISOTimestamp;
+    /** Transaction ID */
+    transactionId: string;
     /** Payment status */
-    status: 'PENDING' | 'COMPLETED' | 'EXPIRED' | 'CANCELLED';
-    /** Payment URL */
-    paymentUrl: string;
-    /** When created */
-    createdAt: ISOTimestamp;
-    /** When expires */
-    expiresAt: ISOTimestamp;
-    /** When completed */
-    completedAt?: ISOTimestamp;
+    status: PaymentStatusType;
+    /** Payment direction */
+    direction: PaymentDirection;
 }
 /**
- * Payment status
+ * Payment details
+ */
+interface PaymentDetails {
+    /** Unique payment identifier */
+    identifier: string;
+    /** Other party identifier (email, phone, or name) */
+    otherPartyIdentifier: string;
+    /** Payment amount */
+    amount: number;
+    /** Payment status */
+    status: PaymentStatusType;
+    /** Transaction timestamp */
+    timestamp: ISOTimestamp;
+    /** Private note from sender (only visible if you're the sender) */
+    senderNote?: string;
+    /** Note from recipient (visible to both parties) */
+    recipientNote?: string;
+    /** Transaction ID */
+    transactionId: string;
+    /** Whether payment was anonymous */
+    anonymous: boolean;
+    /** Transaction type (DEBIT = sent, CREDIT = received) */
+    type: PaymentTransactionType;
+}
+/**
+ * Payment history item
  */
-interface PaymentStatus extends Payment {
+interface PaymentHistoryItem extends PaymentDetails {
+}
+/**
+ * Payment limits
+ */
+interface PaymentLimits {
+    /** Maximum payment amount */
+    maxPaymentAmount: number;
+    /** Minimum payment amount */
+    minPaymentAmount: number;
+    /** Currency for these limits */
+    paymentCurrency: CurrencyCode;
+    /** Type of limit */
+    limitType: string;
+}
+/**
+ * Pay ID response
+ */
+interface PayIdResponse {
+    /** User's Pay ID */
+    payId: string;
+}
+/**
+ * Reverse payment request
+ */
+interface ReversePaymentRequest {
+    /** Transaction ID to reverse */
+    transactionId: string;
+}
+/**
+ * Partial reverse payment request
+ */
+interface PartialReversePaymentRequest {
+    /** Transaction ID to partially reverse */
+    transactionId: string;
+    /** Amount to reverse */
+    amountToReverse: string;
 }
 
 /**
@@ -3357,12 +3435,74 @@ declare class StakeAPI {
 
 /**
  * Pay API methods (requires authentication)
+ * P2P payments within VALR
  */
 declare class PayAPI {
     private http;
     constructor(http: HttpClient);
-    createPayment(request: CreatePaymentRequest): Promise<Payment>;
-    getPaymentStatus(paymentId: string): Promise<PaymentStatus>;
+    /**
+     * Create a new P2P payment
+     * POST /v1/pay
+     *
+     * @param request - Payment request (must specify one of: recipientEmail, recipientCellNumber, or recipientPayId)
+     * @returns Payment response with identifier and transaction ID
+     */
+    createPayment(request: CreatePaymentRequest): Promise<PaymentResponse>;
+    /**
+     * Reverse a payment completely
+     * PUT /v1/pay/transactionid/:transactionId/reverse
+     *
+     * @param transactionId - Transaction ID to reverse
+     * @returns Reversal confirmation
+     */
+    reversePayment(transactionId: string): Promise<void>;
+    /**
+     * Partially reverse a payment
+     * PUT /v1/pay/transactionid/:transactionId/partial-reverse
+     *
+     * @param transactionId - Transaction ID to partially reverse
+     * @param amountToReverse - Amount to reverse
+     * @returns Partial reversal confirmation
+     */
+    partiallyReversePayment(transactionId: string, amountToReverse: string): Promise<void>;
+    /**
+     * Get payment limits for a currency
+     * GET /v1/pay/limits
+     *
+     * @param currency - Currency code (e.g., "BTC", "ZAR")
+     * @returns Payment limits for the specified currency
+     */
+    getPaymentLimits(currency: CurrencyCode): Promise<PaymentLimits>;
+    /**
+     * Get your Pay ID (unique identifier for receiving payments)
+     * GET /v1/pay/payid
+     *
+     * @returns Your Pay ID
+     */
+    getPayId(): Promise<PayIdResponse>;
+    /**
+     * Get payment history (sent and received payments)
+     * GET /v1/pay/history
+     *
+     * @returns Array of payment history items
+     */
+    getPaymentHistory(): Promise<PaymentHistoryItem[]>;
+    /**
+     * Get payment details by identifier
+     * GET /v1/pay/identifier/:identifier
+     *
+     * @param identifier - Payment identifier
+     * @returns Payment details
+     */
+    getPaymentByIdentifier(identifier: string): Promise<PaymentDetails>;
+    /**
+     * Get payment status by transaction ID
+     * GET /v1/pay/transactionid/:transactionId
+     *
+     * @param transactionId - Transaction ID
+     * @returns Payment status
+     */
+    getPaymentStatus(transactionId: string): Promise<PaymentStatus>;
 }
 
 /**
@@ -3911,4 +4051,4 @@ declare const HEADERS: {
     readonly RATE_LIMITED: "x-valr-ratelimited";
 };
 
-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 };
+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

@@ -1821,49 +1821,127 @@ interface EarnHistoryParams {
 }
 
 /**
- * Payment request
+ * Create payment request (P2P payment within VALR)
  */
 interface CreatePaymentRequest {
-    /** Merchant ID */
-    merchantId: string;
-    /** Currency */
+    /** Payment currency */
     currency: CurrencyCode;
-    /** Amount */
-    amount: string;
-    /** Description */
-    description?: string;
-    /** Return URL after payment */
-    returnUrl?: string;
-    /** Callback URL for payment notifications */
-    callbackUrl?: string;
+    /** Payment amount */
+    amount: number | string;
+    /** Recipient's email address (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
+    recipientEmail?: string;
+    /** Recipient's cell number (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
+    recipientCellNumber?: string;
+    /** Recipient's Pay ID (one of: recipientEmail, recipientCellNumber, or recipientPayId required) */
+    recipientPayId?: string;
+    /** Note visible to recipient */
+    recipientNote?: string;
+    /** Private note for sender */
+    senderNote?: string;
+    /** Whether to send payment anonymously */
+    anonymous?: boolean | string;
+}
+/**
+ * Payment creation response
+ */
+interface PaymentResponse {
+    /** Unique payment identifier */
+    identifier: string;
+    /** Transaction ID */
+    transactionId: string;
 }
 /**
- * Payment
+ * Payment status
  */
-interface Payment {
-    /** Payment ID */
-    id: string;
-    /** Merchant ID */
-    merchantId: string;
-    /** Currency */
-    currency: CurrencyCode;
-    /** Amount */
+type PaymentStatusType = 'PENDING' | 'COMPLETE' | 'RETURNED' | 'CANCELLED';
+/**
+ * Payment direction/type
+ */
+type PaymentDirection = 'SEND' | 'RECEIVE';
+/**
+ * Payment transaction type
+ */
+type PaymentTransactionType = 'DEBIT' | 'CREDIT';
+/**
+ * Payment status by transaction ID
+ */
+interface PaymentStatus {
+    /** Payment amount */
     amount: string;
+    /** Transaction timestamp */
+    timestamp: ISOTimestamp;
+    /** Transaction ID */
+    transactionId: string;
     /** Payment status */
-    status: 'PENDING' | 'COMPLETED' | 'EXPIRED' | 'CANCELLED';
-    /** Payment URL */
-    paymentUrl: string;
-    /** When created */
-    createdAt: ISOTimestamp;
-    /** When expires */
-    expiresAt: ISOTimestamp;
-    /** When completed */
-    completedAt?: ISOTimestamp;
+    status: PaymentStatusType;
+    /** Payment direction */
+    direction: PaymentDirection;
 }
 /**
- * Payment status
+ * Payment details
+ */
+interface PaymentDetails {
+    /** Unique payment identifier */
+    identifier: string;
+    /** Other party identifier (email, phone, or name) */
+    otherPartyIdentifier: string;
+    /** Payment amount */
+    amount: number;
+    /** Payment status */
+    status: PaymentStatusType;
+    /** Transaction timestamp */
+    timestamp: ISOTimestamp;
+    /** Private note from sender (only visible if you're the sender) */
+    senderNote?: string;
+    /** Note from recipient (visible to both parties) */
+    recipientNote?: string;
+    /** Transaction ID */
+    transactionId: string;
+    /** Whether payment was anonymous */
+    anonymous: boolean;
+    /** Transaction type (DEBIT = sent, CREDIT = received) */
+    type: PaymentTransactionType;
+}
+/**
+ * Payment history item
  */
-interface PaymentStatus extends Payment {
+interface PaymentHistoryItem extends PaymentDetails {
+}
+/**
+ * Payment limits
+ */
+interface PaymentLimits {
+    /** Maximum payment amount */
+    maxPaymentAmount: number;
+    /** Minimum payment amount */
+    minPaymentAmount: number;
+    /** Currency for these limits */
+    paymentCurrency: CurrencyCode;
+    /** Type of limit */
+    limitType: string;
+}
+/**
+ * Pay ID response
+ */
+interface PayIdResponse {
+    /** User's Pay ID */
+    payId: string;
+}
+/**
+ * Reverse payment request
+ */
+interface ReversePaymentRequest {
+    /** Transaction ID to reverse */
+    transactionId: string;
+}
+/**
+ * Partial reverse payment request
+ */
+interface PartialReversePaymentRequest {
+    /** Transaction ID to partially reverse */
+    transactionId: string;
+    /** Amount to reverse */
+    amountToReverse: string;
 }
 
 /**
@@ -3357,12 +3435,74 @@ declare class StakeAPI {
 
 /**
  * Pay API methods (requires authentication)
+ * P2P payments within VALR
  */
 declare class PayAPI {
     private http;
     constructor(http: HttpClient);
-    createPayment(request: CreatePaymentRequest): Promise<Payment>;
-    getPaymentStatus(paymentId: string): Promise<PaymentStatus>;
+    /**
+     * Create a new P2P payment
+     * POST /v1/pay
+     *
+     * @param request - Payment request (must specify one of: recipientEmail, recipientCellNumber, or recipientPayId)
+     * @returns Payment response with identifier and transaction ID
+     */
+    createPayment(request: CreatePaymentRequest): Promise<PaymentResponse>;
+    /**
+     * Reverse a payment completely
+     * PUT /v1/pay/transactionid/:transactionId/reverse
+     *
+     * @param transactionId - Transaction ID to reverse
+     * @returns Reversal confirmation
+     */
+    reversePayment(transactionId: string): Promise<void>;
+    /**
+     * Partially reverse a payment
+     * PUT /v1/pay/transactionid/:transactionId/partial-reverse
+     *
+     * @param transactionId - Transaction ID to partially reverse
+     * @param amountToReverse - Amount to reverse
+     * @returns Partial reversal confirmation
+     */
+    partiallyReversePayment(transactionId: string, amountToReverse: string): Promise<void>;
+    /**
+     * Get payment limits for a currency
+     * GET /v1/pay/limits
+     *
+     * @param currency - Currency code (e.g., "BTC", "ZAR")
+     * @returns Payment limits for the specified currency
+     */
+    getPaymentLimits(currency: CurrencyCode): Promise<PaymentLimits>;
+    /**
+     * Get your Pay ID (unique identifier for receiving payments)
+     * GET /v1/pay/payid
+     *
+     * @returns Your Pay ID
+     */
+    getPayId(): Promise<PayIdResponse>;
+    /**
+     * Get payment history (sent and received payments)
+     * GET /v1/pay/history
+     *
+     * @returns Array of payment history items
+     */
+    getPaymentHistory(): Promise<PaymentHistoryItem[]>;
+    /**
+     * Get payment details by identifier
+     * GET /v1/pay/identifier/:identifier
+     *
+     * @param identifier - Payment identifier
+     * @returns Payment details
+     */
+    getPaymentByIdentifier(identifier: string): Promise<PaymentDetails>;
+    /**
+     * Get payment status by transaction ID
+     * GET /v1/pay/transactionid/:transactionId
+     *
+     * @param transactionId - Transaction ID
+     * @returns Payment status
+     */
+    getPaymentStatus(transactionId: string): Promise<PaymentStatus>;
 }
 
 /**
@@ -3911,4 +4051,4 @@ declare const HEADERS: {
     readonly RATE_LIMITED: "x-valr-ratelimited";
 };
 
-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 };
+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.js

@@ -1901,12 +1901,93 @@ var PayAPI = class {
   constructor(http) {
     this.http = http;
   }
+  /**
+   * Create a new P2P payment
+   * POST /v1/pay
+   *
+   * @param request - Payment request (must specify one of: recipientEmail, recipientCellNumber, or recipientPayId)
+   * @returns Payment response with identifier and transaction ID
+   */
   async createPayment(request) {
-    const response = await this.http.post("/v1/pay/payment", request);
+    const response = await this.http.post("/v1/pay", request);
+    return response.data;
+  }
+  /**
+   * Reverse a payment completely
+   * PUT /v1/pay/transactionid/:transactionId/reverse
+   *
+   * @param transactionId - Transaction ID to reverse
+   * @returns Reversal confirmation
+   */
+  async reversePayment(transactionId) {
+    await this.http.put(`/v1/pay/transactionid/${transactionId}/reverse`);
+  }
+  /**
+   * Partially reverse a payment
+   * PUT /v1/pay/transactionid/:transactionId/partial-reverse
+   *
+   * @param transactionId - Transaction ID to partially reverse
+   * @param amountToReverse - Amount to reverse
+   * @returns Partial reversal confirmation
+   */
+  async partiallyReversePayment(transactionId, amountToReverse) {
+    await this.http.put(`/v1/pay/transactionid/${transactionId}/partial-reverse`, {
+      amountToReverse
+    });
+  }
+  /**
+   * Get payment limits for a currency
+   * GET /v1/pay/limits
+   *
+   * @param currency - Currency code (e.g., "BTC", "ZAR")
+   * @returns Payment limits for the specified currency
+   */
+  async getPaymentLimits(currency) {
+    const response = await this.http.get("/v1/pay/limits", {
+      params: { currency }
+    });
     return response.data;
   }
-  async getPaymentStatus(paymentId) {
-    const response = await this.http.get(`/v1/pay/payment/${paymentId}`);
+  /**
+   * Get your Pay ID (unique identifier for receiving payments)
+   * GET /v1/pay/payid
+   *
+   * @returns Your Pay ID
+   */
+  async getPayId() {
+    const response = await this.http.get("/v1/pay/payid");
+    return response.data;
+  }
+  /**
+   * Get payment history (sent and received payments)
+   * GET /v1/pay/history
+   *
+   * @returns Array of payment history items
+   */
+  async getPaymentHistory() {
+    const response = await this.http.get("/v1/pay/history");
+    return response.data;
+  }
+  /**
+   * Get payment details by identifier
+   * GET /v1/pay/identifier/:identifier
+   *
+   * @param identifier - Payment identifier
+   * @returns Payment details
+   */
+  async getPaymentByIdentifier(identifier) {
+    const response = await this.http.get(`/v1/pay/identifier/${identifier}`);
+    return response.data;
+  }
+  /**
+   * Get payment status by transaction ID
+   * GET /v1/pay/transactionid/:transactionId
+   *
+   * @param transactionId - Transaction ID
+   * @returns Payment status
+   */
+  async getPaymentStatus(transactionId) {
+    const response = await this.http.get(`/v1/pay/transactionid/${transactionId}`);
     return response.data;
   }
 };