Refunds all or part of a holder's card load back to the card that paid for it.
Use it when a holder should get a load back on their card, for example a duplicate load. Find the load with Search Wallet
Entries (type deposit); its entryId is the depositId. Only a load that was authorized can be refunded, and only
while it is still a card load: once it has matured into customerCredited it can no longer be refunded, and the holder
withdraws it instead.
Requires the Wallet Management permission (see Invite Wallet Holder).
What happens. The refund is queued: the 201 response is requested. It moves to submitted once the amount has
left the wallet and the card refund was accepted, then to reversed when the money is back on the card, or to failed.
Follow it with Search Wallet Entries, filtering entryId on the refundId. No webhook is sent for refunds.
Unlike credits and charges, amount is an object in minor units, and externalId is required. A repeat with the same
externalId, amount, currency, load and reason returns the existing refund with 200 and sends nothing again.
Errors
400 REFUND_EXTERNAL_ID_REQUIRED:externalIdis missing or not 1–128 characters400 REFUND_INVALID_AMOUNT:amount.amountis not a whole number of at least 1, oramount.currencyis not an ISO 4217 code400 REFUND_REASON_REQUIRED:reasonis missing or shorter than 3 characters400 WALLET_CURRENCY_MISMATCH:amount.currencyis not the load's currency400 VALIDATION_ERROR:amount.amountis more than the load's amount (detail codeREFUND_EXCEEDS_DEPOSIT_AMOUNT)404 NOT_FOUND: the wallet or the load does not exist, or they do not belong to this holder409 DEPOSIT_NOT_REFUNDABLE: the load was never authorized, was charged back, or has matured intocustomerCredited409 REFUND_EXCEEDS_REMAINING:amount.amountis more than what is still refundable on the load, after spending and
earlier refunds409 REFUND_ALREADY_EXISTS: a refund with thisexternalIdexists with different terms409 CUSTOMER_FROZEN: your wallet program is frozen. Contact Payment Labs support
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
