Skip to main content
List All Receivers

Authorizations

Authorization
string
header
required

Authorization header containing an SDP JWT (ES256) or an SDP_ API key.

Headers

X-Wallet-Id
string

Optional. Selects the distribution account whose receivers are returned. A receiver is reachable from an account if they were created from it or have been paid from it. Omit it to cover every account you have access to.

Query Parameters

page
number
default:1

The page requested.

page_limit
number
default:20

Define how many results will be returned in the response.

q
string

A search term used to query through the receiver phone_number, email, and ID.

status
enum<string>

Exact match on the status of the receiver wallet.

Available options:
DRAFT,
READY,
REGISTERED,
FLAGGED
created_at_after
string

Only return receivers that are created after this date. Format: YYYY-MM-DD

created_at_before
string

Only return receivers that are created before this date. Format: YYYY-MM-DD

sort
enum<string>
default:updated_at

Field used to sort receivers

Available options:
updated_at,
created_at
direction
enum<string>
default:desc

Direction for sorting receivers.

Available options:
asc,
desc

Response

A paginated list of Receiver details

pagination
object
data
object[]