List All Disbursement Receivers

GET 
/disbursements/:id/receivers

Fetches a list of receivers within a specific disbursement using the disbursement id . This endpoint supports pagination.

Request

Path Parameters

id stringrequired

ID of the Disbursement

Query Parameters

page number

The page number to fetch.

page_limit number

The number of records to return per page.

Responses

200

A list of Disbursement Receivers

application/json

Schema

Schema

pagination object
nextstring
Example: ?page=3&page_limit=2
prevstring
Example: ?page=1&page_limit=2
pagesinteger
Example: 8
totalinteger
Example: 16
data object[]
Array [
idstring
Example: ec3a57c0-5660-4b5a-af76-acadc7b09b93
emailstring
Example: receiver@mail.org
phone_numberstring
Example: +15552368475
external_idstring
Example: usr129001
receiver_wallet object
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
]
payment object
idstring
Example: ddf22f55-3259-4822-a4e2-ce01334997f4
amountstring
The amount of the payment
Example: 100.00
stellar_transaction_idstring
The ID of the transaction in the Stellar network. It can be used tio track the payment in the Stellar network using Stellar Laboratory, or StellarExpert.
Example: 0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b
circle_transfer_request_idstring
The Circle transfer request ID. It is only present when the payment was made using Circle.
Example: 74a68b6a-3f67-424b-b8b0-e593a19d7463
stellar_operation_idstring
statusPaymentStatus (string)
The status of the payment
Possible values: [DRAFT, READY, PENDING, PAUSED, SUCCESS, FAILED, CANCELED]
status_history object[]
An aggregated list of metadata objects containing the statuses and the timestamp of when these status changes occurred.
Array [
statusPaymentStatus (string)
The status of the payment
Possible values: [DRAFT, READY, PENDING, PAUSED, SUCCESS, FAILED, CANCELED]
status_messagestring
timestampdate-time
Example: 2023-02-03T10:45:51Z
]
disbursement object
iduuid
The unique identifier of the disbursement
Example: c51ba1d5-52d3-412f-a59c-6ef32d59ab43
namestring
The name of the disbursement
Example: disbursement-june-29
statusDisbursementStatus (string)
Possible values: [DRAFT, READY, STARTED, PAUSED, COMPLETED]
created_atdate-time
The creation timestamp of the disbursement
Example: 2023-06-30T01:22:57.831975Z
updated_atdate-time
The last update timestamp of the disbursement
Example: 2023-06-30T01:22:58.316511Z
asset object
The Stellar asset object
idstring
Example: ffaec4b3-46b0-4db4-a4c4-6c3508057705
codestring
Asset code
Example: USDC
issuerstring
Asset issuer address
Example: GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5
created_atdate-time
Example: 2023-02-03T10:45:51Z
updated_atdate-time
Example: 2023-02-03T10:45:51Z
deleted_atdate-time
Example: 2023-06-03T10:55:51Z
receiver_wallet object
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
created_atstring
Example: 2023-02-03T10:45:51.000Z
updated_atstring
Example: 2023-02-03T10:45:51.000Z
statusReceiversWalletStatus (string)
Possible values: [DRAFT, READY, REGISTERED, FLAGGED]
created_atdate-time
Example: 2023-02-03T10:45:51Z
updated_atdate-time
Example: 2023-02-03T10:45:51Z
created_atdate-time
Example: 2023-02-03T10:45:51Z
updated_atdate-time
Example: 2023-02-03T10:45:51Z
]

Example (auto)

{
  "pagination": {
    "next": "?page=3&page_limit=2",
    "prev": "?page=1&page_limit=2",
    "pages": 8,
    "total": 16
  },
  "data": [
    {
      "id": "ec3a57c0-5660-4b5a-af76-acadc7b09b93",
      "email": "receiver@mail.org",
      "phone_number": "+15552368475",
      "external_id": "usr129001",
      "receiver_wallet": {
        "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"
          }
        ]
      },
      "payment": {
        "id": "ddf22f55-3259-4822-a4e2-ce01334997f4",
        "amount": "100.00",
        "stellar_transaction_id": "0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b",
        "circle_transfer_request_id": "74a68b6a-3f67-424b-b8b0-e593a19d7463",
        "stellar_operation_id": "string",
        "status": "DRAFT",
        "status_history": [
          {
            "status": "DRAFT",
            "status_message": "string",
            "timestamp": "2023-02-03T10:45:51Z"
          }
        ],
        "disbursement": {
          "id": "c51ba1d5-52d3-412f-a59c-6ef32d59ab43",
          "name": "disbursement-june-29",
          "status": "DRAFT",
          "created_at": "2023-06-30T01:22:57.831975Z",
          "updated_at": "2023-06-30T01:22:58.316511Z"
        },
        "asset": {
          "id": "ffaec4b3-46b0-4db4-a4c4-6c3508057705",
          "code": "USDC",
          "issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
          "created_at": "2023-02-03T10:45:51Z",
          "updated_at": "2023-02-03T10:45:51Z",
          "deleted_at": "2023-06-03T10:55:51Z"
        },
        "receiver_wallet": {
          "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",
          "created_at": "2023-02-03T10:45:51.000Z",
          "updated_at": "2023-02-03T10:45:51.000Z",
          "status": "DRAFT"
        },
        "created_at": "2023-02-03T10:45:51Z",
        "updated_at": "2023-02-03T10:45:51Z"
      },
      "created_at": "2023-02-03T10:45:51Z",
      "updated_at": "2023-02-03T10:45:51Z"
    }
  ]
}

401

Unauthorized

*/*

Schema

Schema

errorstring
extras object
statusnumber
messagestring

Example (auto)

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

application/json

Schema

Schema

Example (auto)

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

Example

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

403

Forbidden

*/*

Schema

Schema

errorstring

Example (auto)

{
  "error": "Forbidden"
}

application/json

Schema

Schema

Example (auto)

{
  "error": "Forbidden"
}

Example

{
  "error": "Forbidden"
}

404

Not Found

*/*

Schema

Schema

errorstring
extras object
statusnumber
messagestring

Example (auto)

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

application/json

Schema

Schema

Example (auto)

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

Example

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

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.Get, "https://developers-pr1413.previews.kube001.services.stellar-ops.com/disbursements/:id/receivers");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "<Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

Auth

BearerAuth

Parameters

id — pathrequired

page — query

page_limit — query

ResponseClear

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