Retrieve a Receiver

GET 
/receivers/:id

Fetches detailed information on a specific receiver by id, including all associated wallets.

Request

Path Parameters

id stringrequired

ID of the Receiver.

Responses

200

Receiver Details

application/json

Schema

Schema

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 string

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

status_history

object[]

Array [

status string

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

timestamp date-time

]

]

Example (from schema)

{
  "id": "f83bb638-dda4-41e6-80c9-d03e6eec2aef",
  "phone_number": "+15552368475",
  "external_id": "usr12334",
  "email": "[email protected]",
  "created_at": "2023-02-03T10:45:51.000Z",
  "total_payments": "2",
  "successful_payments": "2",
  "failed_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"
      },
      "stellar_address": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
      "stellar_memo": "string",
      "stellar_memo_type": "string",
      "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_sms_sent": "2023-02-10T10:45:51.000Z",
      "total_payments": "2",
      "payments_received": "2",
      "failed_payments": "0",
      "remaining_payments": "0",
      "received_amounts": [
        {
          "asset_code": "USDC",
          "asset_issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
          "received_amount": "100.00"
        }
      ],
      "status": "DRAFT",
      "status_history": [
        {
          "status": "DRAFT",
          "timestamp": "2023-02-10T10:45:51.000Z"
        }
      ]
    }
  ]
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

response

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

403

Forbidden

Response Headers

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

response

{
  "error": "Forbidden"
}

404

Not Found

Response Headers

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "string",
  "extras": {
    "status": 0,
    "message": "string"
  }
}

response

{
  "error": "Not found",
  "extras": {
    "status": 404,
    "message": "Resource not found"
  }
}

Loading...