POST
/
refunds
curl --location --request POST 'https://api.hub2.io/refunds' \
--header 'ApiKey: [REDACTED]' \
--header 'MerchantId: [REDACTED]' \
--header 'Environment: sandbox' \
--header 'Content-Type: application/json' \
--data-raw '{
  "id": "tr_000000000000000000011",
  "zendeskTicketId": "zd_123456"
}'

{
  "id": 123,
  "status": "created",
  "transactionId": "tr_000000000000000000011",
  "amount": 2000,
  "currency": "XOF",
  "reason": "Customer requested refund",
  "paymentMethod": "mobile_money",
  "fallbackAllowed": true,
  "fallbackUsed": false,
  "metadata": {},
  "zendeskTicketId": "zd_123456",
  "createdAt": "2023-01-01T12:00:00.000Z",
  "updatedAt": "2023-01-01T12:00:00.000Z"
}
Creates a refund for a previously successful transfer. The refund will be processed asynchronously and you will receive webhook notifications about status changes.

​
Request

​
id
string
required
The transfer ID to refund (e.g., tr_000000000000000000011)
​
zendeskTicketId
string
Zendesk ticket ID associated with the refund (e.g., zd_123456)

​
Response

​
id
number
The unique refund ID
​
status
string
The current status of the refund. Possible values: created, pending, pending_manual, successful, failed
​
transactionId
string
The original transfer ID that is being refunded
​
amount
number
The refund amount (same as original transfer)
​
currency
string
The currency of the refund (e.g., XOF, USD)
​
reason
string
The reason for the refund
​
paymentMethod
string
The payment method used for the refund. Possible values: mobile_money, bank_transfer
​
fallbackAllowed
boolean
Whether fallback methods are allowed for this refund
​
fallbackUsed
boolean
Whether a fallback method was used for this refund
​
metadata
object
Additional metadata associated with the refund
​
zendeskTicketId
string
The Zendesk ticket ID associated with the refund
​
createdAt
string
The date and time when the refund was created
​
updatedAt
string
The date and time when the refund was last updated
curl --location --request POST 'https://api.hub2.io/refunds' \
--header 'ApiKey: [REDACTED]' \
--header 'MerchantId: [REDACTED]' \
--header 'Environment: sandbox' \
--header 'Content-Type: application/json' \
--data-raw '{
  "id": "tr_000000000000000000011",
  "zendeskTicketId": "zd_123456"
}'

{
  "id": 123,
  "status": "created",
  "transactionId": "tr_000000000000000000011",
  "amount": 2000,
  "currency": "XOF",
  "reason": "Customer requested refund",
  "paymentMethod": "mobile_money",
  "fallbackAllowed": true,
  "fallbackUsed": false,
  "metadata": {},
  "zendeskTicketId": "zd_123456",
  "createdAt": "2023-01-01T12:00:00.000Z",
  "updatedAt": "2023-01-01T12:00:00.000Z"
}