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

Retrieve refund

Get details of a refund for a card transfer.

To use this endpoint from the browser, you’ll need to specify the /accounts/{accountID}/transfers.read scope when generating a token.
GET
/transfers/{transferID}/refunds/{refundID}
cURL Go JavaScript 
1
2

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

1
2
3
4
5
6

mc, _ := moov.NewClient()

var transferID string
var refundID string

mc.GetRefund(ctx, transferID, refundID)

1
2
3

const moov = new Moov(credentialsObject);

moov.transfers.getRefund(transferID, refundID)
200 429
Details about a particular refund.
retrieveRefundResponse
{
  "amount": {
    "currency": "USD",
    "value": 1204
  },
  "cardDetails": {
    "completedOn": "2024-08-24T14:15:22Z",
    "confirmedOn": "2024-08-24T14:15:22Z",
    "initiatedOn": "2024-08-24T14:15:22Z",
    "settledOn": "2024-08-24T14:15:22Z",
    "status": "completed"
  },
  "createdOn": "2024-08-24T14:15:22Z",
  "refundID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
  "status": "completed",
  "updatedOn": "2024-08-24T14:15:22Z"
}
Request was refused due to rate limiting.

Response headers

Retry-After

number

Path parameters

transferID

string <uuid> required
Identifier for the transfer.

refundID

string <uuid> required
Identifier for the refund.

Query parameters

accountID

string <uuid>
Identifier for a connected account. Must be provided when using a token and the value of {accountID} in the scopes is a connected account.

Response

application/json
Details of a card refund.

amount

object required
An integer value representing money in a specific currency.
right_key Show child attributes

currency

string <=3 characters Pattern
A 3-letter ISO 4217 currency code.

value

integer<int64>
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> <=24 characters required

refundID

string<uuid> <=36 characters required
UUID v4

status

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

updatedOn

string<date-time> <=24 characters required

cardDetails

object
right_key Show child attributes

status

string<enum> required
Status of the refund.
Possible values: initiated, confirmed, settled, failed, completed

completedOn

string<date-time> <=24 characters

confirmedOn

string<date-time> <=24 characters

failedOn

string<date-time> <=24 characters

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> <=24 characters

settledOn

string<date-time> <=24 characters