HUhub2
Refunds

Get Refund

Changed on

This endpoint allows you to retrieve a refund

get/refunds/{id}

Request

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

Path parameters

idstring required

Headers

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.

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.

Environment'live' | 'sandbox' required

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

Response

idnumber required

Identifier of the refund

transactionIdstring required

Identifier of the refunded transfer

status'created' | 'pending' | 'pending_manual' | 'failed' | 'successful' required

Status of the refund

amountnumber required

Refunded amount in the smallest currency unit

currencystring required

Three-letter ISO 4217 currency code

reasonstring required

Reason of the refund

paymentMethod'mobile_money' | 'bank_transfer' required

Method the refund is paid back with

fallbackUsedboolean required

Whether the refund was paid back through the fallback method

createdAtstring date-time required

Creation date of the refund, UTC

updatedAtstring date-time required

Last update date of the refund, UTC

Example response

{
  "id": 1,
  "transactionId": "tr_z1urYtVFgEebtcj8fxp4v",
  "status": "successful",
  "amount": 1000,
  "currency": "XOF"
}

Changes