Get refund

Transactions

Fetch a specific refund by its unique identifier. This endpoint returns detailed information about the refund including its current status, amount, and associated transaction details.

GEThttps://api.efundpay.com/v4/refunds/{refund_id}

This endpoint requires the transactions.read scope.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token.

Headers

x-merchant-account-idstringrequired

The ID of the merchant account to use for this request.

Examples:""default""

Path Parameters

refund_idstringrequired

The unique identifier of the refund to retrieve.

Examples:"6a1d4e46-14ed-4fe1-a45f-eff4e025d211"

Response

application/json

Successful Response

typestringrequired

Resource type, always "refund".

Examples:"refund"

idstringrequired

Unique refund identifier.

Examples:"6a1d4e46-14ed-4fe1-a45f-eff4e025d211"

transaction_idstringrequired

The ID of the transaction being refunded.

Examples:"7099948d-7286-47e4-aad8-b68f7eb44591"

statusstringrequired

Refund status. Values: processing (including pending or reconciliation states), succeeded, failed (including expired), or voided (canceled).

Examples:"processing""succeeded""failed""voided"

currencystringrequired

ISO 4217 three-letter currency code.

Examples:"EUR""USD""GBP"

amountintegerrequired

Refund amount in the smallest currency unit.

Examples:"1299"

reasonstringrequired

Reason for the refund.

Examples:"Refund due to user request."

external_identifierstringrequired

External identifier for the refund.

Examples:"refund-12345"

transaction_external_identifierstringrequired

External identifier for the original transaction.

Examples:"transaction-12345"

created_atstringrequired

Creation time (ISO 8601).

Examples:"2013-07-16T19:23:00.000+00:00"

curl --request GET \
  --url https://api.efundpay.com/v4/refunds/6a1d4e46-14ed-4fe1-a45f-eff4e025d211 \
  --header 'Authorization: Bearer <token>' \
  --header 'x-merchant-account-id: <x-merchant-account-id>' \

{
  "type": "refund",
  "id": "6a1d4e46-14ed-4fe1-a45f-eff4e025d211",
  "transaction_id": "7099948d-7286-47e4-aad8-b68f7eb44591",
  "status": "succeeded",
  "currency": "EUR",
  "amount": 1299,
  "reason": "Refund due to user request.",
  "external_identifier": "refund-12345",
  "transaction_external_identifier": "transaction-12345",
  "created_at": "2013-07-16T19:23:00.000+00:00"
}