Skip to main content

List All Receivers

GET 

/receivers

Returns all receivers matching the request criteria. This endpoint supports pagination and filtering on receiver status, receiver attributes, and timestamp. Each payment has details on the receiver, high-level payments metrics, and wallets associated with the receiver.

Request

Query Parameters

    page number

    Default value: 1

    The page requested.

    page_limit number

    Default value: 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 string

    Possible values: [DRAFT, READY, REGISTERED, FLAGGED]

    Exact match on the status of the receiver wallet.

    Example: DRAFT
    created_at_after string

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

    Example: 2006-01-02
    created_at_before string

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

    Example: 2006-01-02
    sort string

    Possible values: [created_at]

    Default value: created_at

    Field used to sort receivers

    direction string

    Possible values: [asc, desc]

    Default value: asc

    Direction for sorting receivers.

Responses

A paginated list of Receiver details

Schema

    pagination

    object

    next string
    prev string
    pages integer
    total integer

    data

    object[]

  • Array [

  • id string
    phone_number string
    external_id string
    email string
    created_at string
    total_payments string
    successful_payments string
    failed_payments string
    remaining_payments string
    registered_wallets string

    received_amounts

    object[]

  • Array [

  • asset_code string
    asset_issuer string
    received_amount string
  • ]

  • wallets

    object[]

  • Array [

  • id string

    receiver

    object

    id string

    wallet

    object

    id string
    name string
    homepage string
    stellar_address string
    stellar_memo string
    stellar_memo_type string
    created_at string
    updated_at string
    invited_at string
    last_sms_sent string

    timestamp when the receiver last received an SMS about this wallet

    total_payments string
    payments_received string
    failed_payments string
    remaining_payments string

    received_amounts

    object[]

  • Array [

  • asset_code string
    asset_issuer string
    received_amount string
  • ]

  • status ReceiversWalletStatus (string)

    Possible values: [DRAFT, READY, REGISTERED, FLAGGED]

    status_history

    object[]

  • Array [

  • status ReceiversWalletStatus (string)

    Possible values: [DRAFT, READY, REGISTERED, FLAGGED]

    timestamp date-time
  • ]

  • ]

  • ]

Loading...