Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 2.62 KB

File metadata and controls

22 lines (14 loc) · 2.62 KB

CreateRefundRequest

Properties

Name Type Description Notes
requestId String The request ID that is used to track a refund request. The request ID is provided by you and must be unique.
merchantId String The merchant ID. [optional]
payableAmount String The amount to refund in cryptocurrency. The amount must be a positive number and can have up to two decimal places
toAddress String The address where the refunded cryptocurrency will be sent. [optional]
tokenId String The ID of the cryptocurrency used for refund. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`
refundType RefundType
orderId String The ID of the original pay-in order associated with this refund. Use this to track refunds against specific payments. [optional]
chargeMerchantFee Boolean Whether to charge developer fee to the merchant. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to Accounts and fund allocation. - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance - `false`: The merchant is not charged any developer fee When enabled, ensure both `merchant_fee_amount` and `merchant_fee_token_id` are properly specified. [optional]
merchantFeeAmount String The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This field is only valid when `refund_type` is `Merchant`. For more information, please refer to Accounts and fund allocation. This field is required when `charge_merchant_fee` is `true`. Must be: - A positive integer with up to two decimal places. - Less than the refund amount [optional]
merchantFeeTokenId String The ID of the cryptocurrency used for the transaction fee. This is only applicable if `charge_merchant_fee` is set to true. [optional]