Skip to main content

Create a refund order

POST 
/api/v1/order/refund

Create a refund for an incoming, completed payment or deposit order. This endpoint allows you to return part or all of the funds received from a payment or deposit order to the payer. Refunds can only be processed if there are sufficient funds in the wallet balance, including fees.

Refunds cannot exceed the total amount received for the order. For example, if the original order was 10, and a refund of 5 has already been issued, the maximum you can refund in a second transaction is 5.

Request​

Body

Details of the refund order to create.

    amount stringrequired

    The amount to refund to the payer. It should be a positive decimal number, specified with up to 6 decimal places.

    assetId stringrequired

    Possible values: [TRX, USDT_TRC20]

    The asset used for the refund. Ensure that the asset matches the one used in the original payment order.

    destinationAddress stringrequired

    The wallet address where the refund will be sent. It should be a valid blockchain address for the specified asset.

    refundOrderId stringrequired

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    The unique identifier of the original order that is being refunded. This ID helps link the refund to the correct order.

Responses​

Refund order created successfully.

Schema
    orderId stringrequired

    The unique identifier of the created refund or withdrawal order. Use this ID to track the order's status .

Loading...