Update a Receiver

This endpoint allows an organization to add and update information on the receiver, including email address, external ID, date of birth, personal PIN, and national ID number. The response includes all information on the receiver.

Path Parameters

• id string required

  ID of the Receiver.

application/json

Request Body required

List of fields to patch for the receiver

• date_of_birth string

  Date of birth of the receiver

• pin string

  Personal identification number of the receiver

• national_id string

  National ID of the receiver

• email string

  Email of the receiver

• external_id string

  External ID of the receiver

Responses

• 200
• 400
• 401
• 403
• 404

---

Updated Receiver Details

application/json

• Schema
• Example (from 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

  ]

  ]

{
  "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"
        }
      ]
    }
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• message string

  Details about the error

{
  "message": "string"
}

Unauthorized

Response Headers

application/json

• Schema
• Example (from schema)
• response

---

Schema

• error string
• extras object

  status number

  message string

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

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

Forbidden

Response Headers

application/json

• Schema
• Example (from schema)
• response

---

Schema

• error string

{
  "error": "Forbidden"
}

{
  "error": "Forbidden"
}

Not Found

Response Headers

application/json

• Schema
• Example (from schema)
• response

---

Schema

• error string
• extras object

  status number

  message string

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

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

Loading...