Skip to main content
GET
RedPacket - Get

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Red packet identifier

Response

200 - application/json

Successful response

Red packet detail

creator
string
required

Creator wallet address

Example:

"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"

id
string
required

Red packet identifier

Example:

"Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB"

maxClaims
integer<int32>
required

Maximum number of claims allowed

Example:

10

mint
string
required

Token mint address

Example:

"Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB"

totalAmount
string
required

Total amount in the red packet

Example:

"1000000000"

chain
string | null

Blockchain network for the red packet

Example:

"sol"

claimAuthority
string | null

Claim authority address

Example:

"Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB"

claimedAmount
string | null

Amount claimed from the red packet

Example:

"500000000"

claimedCount
integer<int32> | null

Number of claims made

Example:

5

createdAt
integer<int64> | null

Red packet creation timestamp

Example:

1717334400000

expiration
integer<int64> | null

Expiration duration in seconds

Example:

24

expired
boolean | null

Whether the red packet has been withdrawn

expiredAt
integer<int64> | null

Expiration timestamp

Example:

1717420800000

memo
string | null

Red packet memo message

Example:

"Happy Red Packet"

refundedAmount
string | null

Refunded amount

Example:

"0"

shareId
string | null

Share identifier

Example:

"abc123"

txHash
string | null

Transaction hash

Example:

"5UfDuX7hXbL3mFfPdq1pymNHM..."