Skip to main content
GET
Get a refund

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

Response

id
string
required
payout_id
string
required

The failed payout this refund returns

inflow_id
object | null
required

The inflow whose money is being sent back

status
enum<string>
required
Available options:
PENDING,
PROCESSING,
SUCCESSFUL,
FAILED
received_amount
number
required

What the merchant originally sent us

Example:

42.32

received_currency
string
required
Example:

"USDT"

network_fee_amount
number
required

Cost of sending the refund back out

Example:

1

network_fee_currency
string
required
Example:

"USDT"

refund_amount
number
required

received_amount minus network_fee_amount

Example:

41.32

refund_currency
string
required
Example:

"USDT"

destination_type
enum<string>
required
Available options:
BANK_ACCOUNT,
CRYPTO_ADDRESS
destination_provider_name
string
required
Example:

"USDT (TRC-20)"

destination_masked
string
required

Masked account number or address

Example:

"TXyz...abcd"

destination_network
enum<string> | null
required
Available options:
TRON,
BSC
processor_reference
object | null
required
failure_reason
object | null
required
attempt_number
number
required
Example:

1

dispatched_at
object | null
required
settled_at
object | null
required
created_at
string
required