STstellar
Receivers

Update a Receiver

Changed on

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.

patch/receivers/{id}

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

Path parameters

idstring required

ID of the Receiver.

Request body */*

date_of_birthstring

Date of birth of the receiver

pinstring

Personal identification number of the receiver

national_idstring

National ID of the receiver

emailstring

Email of the receiver

phone_numberstring

Phone number of the receiver

external_idstring

External ID of the receiver

Example request

{
  "date_of_birth": "1980-01-01",
  "pin": "1234",
  "national_id": "123456789",
  "email": "john@example.com",
  "external_id": "external123"
}

Response

Updated Receiver Details

idstring
phone_numberstring
external_idstring
emailstring
created_atstring
total_paymentsstring
successful_paymentsstring
failed_paymentsstring
canceled_paymentsstring
remaining_paymentsstring
registered_walletsstring

Example response

{
  "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 optional property to the response with the status

    • info

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

  • b6f8a6e65559Revision changes
    • 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