Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Money movement
  3. Refunds

Retrieve refund

Get details of a refund for a card transfer.

To access this endpoint using an access token you’ll need to specify the /accounts/{accountID}/transfers.read scope.

GET
/accounts/{accountID}/transfers/{transferID}/refunds/{refundID}
cURL Go 
1
2

curl -X GET "https://api.moov.io/accounts/{accountID}/transfers/{transferID}/refunds/{refundID}" \
  -H "Authorization: Bearer {token}" \

1
2
3
4
5
6
7

mc, _ := moov.NewClient()

var accountID string
var transferID string
var refundID string

mc.GetRefund(ctx, accountID, transferID, refundID)
200 401 403 404 429 500 504
The request completed successfully.
Details of a card refund.
{
  "amount": {
    "currency": "USD",
    "value": 1204
  },
  "cardDetails": {
    "completedOn": "2019-08-24T14:15:22Z",
    "confirmedOn": "2019-08-24T14:15:22Z",
    "failedOn": "2019-08-24T14:15:22Z",
    "failureCode": "call-issuer",
    "initiatedOn": "2019-08-24T14:15:22Z",
    "settledOn": "2019-08-24T14:15:22Z",
    "status": "initiated"
  },
  "createdOn": "2019-08-24T14:15:22Z",
  "refundID": "3201ff26-41a3-4c08-a930-5a0af7f01fcb",
  "status": "created",
  "updatedOn": "2019-08-24T14:15:22Z"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The requested resource was not found.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Path parameters

transferID

string <uuid> required
Identifier for the transfer.

accountID

string <uuid> required

refundID

string <uuid> required
Identifier for the refund.

Response

application/json
Details of a card refund.

amount

object required
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

value

integer<int64> required

Quantity in the smallest unit of the specified currency.

In USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.

createdOn

string<date-time> required

refundID

string<uuid> required
Identifier for the refund.

status

string<enum> required
Possible values: created, pending, completed, failed

updatedOn

string<date-time> required

cardDetails

object
Show child attributes

status

string<enum> required
Possible values: initiated, confirmed, settled, failed, completed

completedOn

string<date-time>

confirmedOn

string<date-time>

failedOn

string<date-time>

failureCode

string<enum>
Possible values: call-issuer, do-not-honor, processing-error, invalid-transaction, invalid-amount, no-such-issuer, reenter-transaction, cvv-mismatch, lost-or-stolen, insufficient-funds, invalid-card-number, invalid-merchant, expired-card, incorrect-pin, transaction-not-allowed, suspected-fraud, amount-limit-exceeded, velocity-limit-exceeded, revocation-of-authorization, card-not-activated, issuer-not-available, could-not-route, cardholder-account-closed, unknown-issue, duplicate-transaction

initiatedOn

string<date-time>

settledOn

string<date-time>