List refunds
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
|
|
|
|
|
|
List of refunds.
[
{
"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.
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
amount
object
An integer value representing money in a specific currency.
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.
cardDetails
object
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
createdOn
string<date-time>
<=24 characters
refundID
string<uuid>
<=36 characters
UUID v4
status
string<enum>
Possible values:
created
,
pending
,
completed
,
failed
updatedOn
string<date-time>
<=24 characters