STstellar
Receivers

List All Receivers

Changed on

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.

get/receivers

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Query parameters

pagenumber

The page requested.

page_limitnumber

Define how many results will be returned in the response.

qstring

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

status'DRAFT' | 'READY' | 'REGISTERED' | 'FLAGGED'

Exact match on the status of the receiver wallet.

created_at_afterstring

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

created_at_beforestring

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

sort'updated_at' | 'created_at'

Field used to sort receivers

direction'asc' | 'desc'

Direction for sorting receivers.

Headers

X-Wallet-Idstring

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.

Response

A paginated list of Receiver details

Example response

{
  "pagination": {
    "next": "?page=3&page_limit=2",
    "prev": "?page=1&page_limit=2",
    "pages": 8,
    "total": 16
  },
  "data": [
    {
      "id": "f83bb638-dda4-41e6-80c9-d03e6eec2aef",
      "phone_number": "+15552368475",
      "external_id": "usr12334",
      "email": "jdoe@mail.org",
      "created_at": "2023-02-03T10:45:51.000Z",
      "total_payments": "2",
      "successful_payments": "2",
      "failed_payments": "0",
      "canceled_payments": "0",
      "remaining_payments": "0",
      "registered_wallets": "1",
      "received_amounts": [
        {
          "asset_code": "USDC",
          "asset_issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
          "received_amount": "100.00"
        }
      ],
      "wallets": [
        {
          "id": "803031d4-1d04-4879-b6d9-dc5641f9988e",
          "receiver": {
            "id": "029e2ed0-feb6-4c40-8b47-0836a85741a2"
          },
          "wallet": {
            "id": "5ada9ed5-455a-4782-a0ee-160767e0deb1",
            "name": "Vibrant Assist",
            "homepage": "https://vibrantapp.com",
            "sep_10_client_domain": "api-dev.vibrantapp.com",
            "deep_link_schema": "https://vibrantapp.com/sdp-dev",
            "enabled": true
          },
          "stellar_address": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
          "created_at": "2023-02-03T10:45:51.000Z",
          "updated_at": "2023-02-03T10:45:51.000Z",
          "invited_at": "2023-02-09T10:45:51.000Z",
          "last_message_sent_at": "2023-02-10T10:45:51.000Z",
          "total_payments": "2",
          "payments_received": "2",
          "failed_payments": "0",
          "canceled_payments": "0",
          "remaining_payments": "0",
          "received_amounts": [
            {
              "asset_code": "USDC",
              "asset_issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
              "received_amount": "100.00"
            }
          ],
          "status_history": [
            {
              "timestamp": "2023-02-10T10:45:51Z"
            }
          ]
        }
      ]
    }
  ]
}

Changes

  • 7588d8d2a3c7Revision changes
    • info

      added the new optional header request parameter X-Wallet-Id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

  • b6f8a6e65559Revision changes
    • breaking

      for the query request parameter direction, default value was changed from asc to desc

    • breaking

      for the query request parameter sort, default value was changed from created_at to updated_at

    • info

      added the new enum value updated_at to the query request parameter sort

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status