HUhub2
Payments Refunds

Create Refund for a Payment

Changed on

This endpoint allows you to create a refund for a payment. The refund amount plus its fees must be covered by the available balance of your collection account: otherwise the request is refused with a 409 refund_exceeds_available_balance, whose message states the maximum refundable amount.

post/payments-refund/{id}/refund

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: ApiKey, MerchantId, Environment

Path parameters

idstring required

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Request body

amountnumber required

The amount to refund

reasonCodestring required

The reason for the refund

reasonDetailsstring required

The details of the reason for the refund

Example request

{
  "amount": 100,
  "reasonCode": "customer_request",
  "reasonDetails": "Customer requested a refund"
}

Response

idnumber required

The payment refund record id

Example response

{
  "id": 2
}

Changes