Update a Receiver

PATCH 
/receivers/:id

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.

Request

Path Parameters

id stringrequired

ID of the Receiver.

*/*

Bodyrequired

List of fields to patch for the receiver

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

Responses

200

Updated Receiver Details

application/json

Schema

Schema

idstring
Example: f83bb638-dda4-41e6-80c9-d03e6eec2aef
phone_numberstring
Example: +15552368475
external_idstring
Example: usr12334
emailstring
Example: jdoe@mail.org
created_atstring
Example: 2023-02-03T10:45:51.000Z
total_paymentsstring
Example: 2
successful_paymentsstring
Example: 2
failed_paymentsstring
Example: 0
remaining_paymentsstring
Example: 0
registered_walletsstring
Example: 1
received_amounts object[]
Array [
asset_codestring
Example: USDC
asset_issuerstring
Example: GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5
received_amountstring
Example: 100.00
]
wallets object[]
Array [
idstring
Example: 803031d4-1d04-4879-b6d9-dc5641f9988e
receiver object
idstring
Example: 029e2ed0-feb6-4c40-8b47-0836a85741a2
wallet object
idstring
Example: 5ada9ed5-455a-4782-a0ee-160767e0deb1
namestring
Example: Vibrant Assist
homepagestring
Example: https://vibrantapp.com
stellar_addressstring
Example: GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL
stellar_memostring
stellar_memo_typestring
created_atstring
Example: 2023-02-03T10:45:51.000Z
updated_atstring
Example: 2023-02-03T10:45:51.000Z
invited_atstring
Example: 2023-02-09T10:45:51.000Z
last_message_sent_atstring
timestamp when the receiver last received an invitation about this wallet
Example: 2023-02-10T10:45:51.000Z
total_paymentsstring
Example: 2
payments_receivedstring
Example: 2
failed_paymentsstring
Example: 0
remaining_paymentsstring
Example: 0
received_amounts object[]
Array [
asset_codestring
Example: USDC
asset_issuerstring
Example: GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5
received_amountstring
Example: 100.00
]
statusReceiversWalletStatus (string)
Possible values: [DRAFT, READY, REGISTERED, FLAGGED]
status_history object[]
Array [
statusReceiversWalletStatus (string)
Possible values: [DRAFT, READY, REGISTERED, FLAGGED]
timestampdate-time
Example: 2023-02-10T10:45:51Z
]
]

Example (auto)

{
  "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",
  "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_message_sent_at": "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:51Z"
        }
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

errorstring
Details about the error
extras object
object

Example (auto)

{
  "error": "Invalid input",
  "extras": {
    "field_foo": "field_foo is required",
    "field_bar": "field_bar needs to be an integer"
  }
}

401

Unauthorized

application/json

Schema

Schema

errorstring
extras object
statusnumber
messagestring

Example (auto)

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

Example

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

403

Forbidden

application/json

Schema

Schema

errorstring

Example (auto)

{
  "error": "Forbidden"
}

Example

{
  "error": "Forbidden"
}

404

Not Found

application/json

Schema

Schema

errorstring
extras object
statusnumber
messagestring

Example (auto)

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

Example

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

409

Conflicting phone number or email

application/json

Schema

Schema

errorstring
extrasobject

Example (auto)

{
  "error": "string",
  "extras": {}
}

Example

{
  "error": "The provided email is already associated with another user.",
  "extras": {
    "email": "email must be unique"
  }
}

Authorization: Authorization

name: Authorizationtype: apiKeydescription: JWT used for authentication, signed with an ES256 private key.in: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "https://developers-pr1413.previews.kube001.services.stellar-ops.com/receivers/:id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "<Authorization>");
var content = new StringContent(string.Empty);
content.Headers.ContentType = new MediaTypeHeaderValue("*/*");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

Auth

BearerAuth

Parameters

id — pathrequired

Body required

ResponseClear

Click the Send API Request button above and see the response here!