Skip to main content
GET
Get a withdrawal

Authorizations

x-spacepay-secret-key
string
header
required

Secret key for authentication of external API.

Path Parameters

withdrawalId
string
required

Response

Withdrawal retrieved successfully

id
string<uuid>
required

Withdrawal ID

merchantId
string<uuid>
required

Merchant ID

amountInCents
number
required

Withdrawal amount in USD cents

chainId
string
required

CAIP-2 chain id

Example:

"eip155:8453"

recipientAddress
string
required

Beneficiary address

status
enum<string>
required

Withdrawal status

Available options:
pending,
processing,
completed,
failed,
cancelled
currency
enum<string>
required

Currency of the withdrawal

Available options:
USD
orderId
string | null
required

Optional order ID

customMetadata
string | null
required

Optional custom metadata

errorMessage
string | null
required

Error message (if failed)

receipt
object | null
required

Withdrawal receipt

createdAt
string<date-time>
required

Created at

updatedAt
string<date-time>
required

Updated at