Skip to main content

Get refund

GEThttps://api.radom.com/refund/{id}

Authorization

Send your API key in the Authorization header. Scheme: radomToken.

Parameters

idstring<uuid>pathrequired

Unique identifier for the refund.

Responses

200Refund retrieved successfully
idstring<uuid>required
organizationIdstring<uuid>required
withdrawalIdstring<uuid>nullable
associatedEntityTypeAssociatedEntityTyperequired
AllowedPaymentLinkOrderCheckoutSessionInvoicePaymentSessionSubscriptionDonationLinkOrder
associatedEntityIdstring<uuid>required
statusRefundStatusrequired
AllowedpendingsuccesscancelledfailedinReview
networkNetworkrequired
AllowedBitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiat
tokenstringnullable
amountstringrequired
chargeCustomerNetworkFeebooleanrequired
recipientAddressstringnullable
createdAtstring<date-time>required
recipientAccountJsonnullable
ivyOrderIdstringnullable
failureReasonstringnullable
initiatedByUserIdstring<uuid>nullable
initiatedByAdminUserIdstring<uuid>nullable
feeAmountstringnullable
ivyRefundIdstringnullable

Ivy's id for the refund object itself (the create response only returns the order id; this is learned from the webhook or the reconciler).

fiatAmountstringnullable
fiatCurrencystringnullable
providerPayoutIdstringnullable

Set when the refund executes as an Ivy payout (non-EEA payers, where SEPA needs the recipient address the refund API can't carry).

400Bad Request
errorstringrequired
401Unauthorized
errorstringrequired
500Internal server error
errorstringrequired