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
next string
prev string
pages integer
total integer
data object[]
Array [
id string
email string
phone_number string
external_id string
receiver_wallet object
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
]
payment object
id string
amount string
stellar_transaction_id string
stellar_operation_id string
status string
Possible values: [DRAFT, READY, PENDING, PAUSED, SUCCESS, FAILED]
status_history object[]
Array [
status string
Possible values: [DRAFT, READY, PENDING, PAUSED, SUCCESS, FAILED]
status_message string
timestamp date-time
]
disbursement object
id uuid
The unique identifier of the disbursement
name string
The name of the disbursement
status string
Possible values: [DRAFT, READY, STARTED, PAUSED, COMPLETED]
created_at date-time
The creation timestamp of the disbursement
updated_at date-time
The last update timestamp of the disbursement
asset object
id string
code string
Asset code
issuer string
Asset issuer address
created_at date-time
updated_at date-time
deleted_at date-time
receiver_wallet object
id string
receiver object
id string
wallet object
id string
name string
homepage string
stellar_address string
created_at string
updated_at string
status string
Possible values: [DRAFT, READY, REGISTERED, FLAGGED]
created_at date-time
updated_at date-time
created_at date-time
updated_at date-time
]

Example (from schema)

{
  "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": "[email protected]",
      "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_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"
          }
        ]
      },
      "payment": {
        "id": "ddf22f55-3259-4822-a4e2-ce01334997f4",
        "amount": "100.00",
        "stellar_transaction_id": "0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b",
        "stellar_operation_id": "string",
        "status": "DRAFT",
        "status_history": [
          {
            "status": "DRAFT",
            "status_message": "string",
            "timestamp": "2023-02-03T10:45:51.000Z"
          }
        ],
        "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:51.000Z",
          "updated_at": "2023-02-03T10:45:51.000Z",
          "deleted_at": "2023-06-03T10:55:51.000Z"
        },
        "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:51.000Z",
        "updated_at": "2023-02-03T10:45:51.000Z"
      },
      "created_at": "2023-02-03T10:45:51.000Z",
      "updated_at": "2023-02-03T10: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": "Not found",
  "extras": {
    "status": 404,
    "message": "Disbursement not found"
  }
}

response

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

Loading...