Sign in
Disbursements

List All Disbursement Receivers

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

get/disbursements/{id}/receivers

Path parameters

idstring required

ID of the Disbursement

Query parameters

pagenumber

The page number to fetch.

page_limitnumber

The number of records to return per page.

sort'updated_at' | 'created_at'

Field used to sort receivers

direction'asc' | 'desc'

Direction for sorting receivers.

Response

A list of Disbursement Receivers

Example response

{
  "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",
          "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",
        "remaining_payments": "0",
        "received_amounts": [
          {
            "asset_code": "USDC",
            "asset_issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
            "received_amount": "100.00"
          }
        ],
        "status_history": [
          {
            "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",
        "status_history": [
          {
            "timestamp": "2023-02-03T10:45:51Z"
          }
        ],
        "disbursement": {
          "id": "c51ba1d5-52d3-412f-a59c-6ef32d59ab43",
          "name": "disbursement-june-29",
          "receiver_registration_message_template": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.",
          "status_history": [
            {
              "user_id": "3f351b9e-ed0f-40fa-a314-14757b42dab1",
              "timestamp": "2023-02-03T10:45:51Z"
            }
          ],
          "file_name": "disbursement-feb-03-2023.csv",
          "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",
            "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",
          "invitation_sent_at": "2023-02-09T10:45:51.000Z",
          "status_history": [
            {
              "timestamp": "2023-02-10T10:45:51Z"
            }
          ],
          "otp_confirmed_at": "2023-02-10T10:45:51Z"
        },
        "external_payment_id": "payment-001",
        "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"
    }
  ]
}

Changes

Changed in 3 of the 11 revisions of this API.5328

  • b6f8a6e65559524See the full diff
    • ▲

      for the query request parameter page, default value 1 was added

      request-parameter-default-value-added

    • ▲

      for the query request parameter page_limit, default value 20 was added

      request-parameter-default-value-added

    • ▲

      removed the media type */* for the response with the status 401

      response-media-type-removed

    • ▲

      removed the media type */* for the response with the status 403

      response-media-type-removed

    • ▲

      removed the media type */* for the response with the status 404

      response-media-type-removed

    • ○

      added the new optional query request parameter direction

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sort

      new-optional-request-parameter

    • ○

      added the optional property data/items/payment/disbursement/file_name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/disbursement/receiver_registration_message_template to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/disbursement/registration_contact_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/disbursement/status_history to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/disbursement/verification_field to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/external_payment_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/receiver_wallet/invitation_sent_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/receiver_wallet/otp_confirmed_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/receiver_wallet/otp_confirmed_with to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/receiver_wallet/sep24_transaction_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/receiver_wallet/status_history to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/receiver_wallet/stellar_memo to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/receiver_wallet/stellar_memo_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/receiver_wallet/wallet/deep_link_schema to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/receiver_wallet/wallet/enabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/receiver_wallet/wallet/sep_10_client_domain to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/receiver_wallet/wallet/user_managed to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/payment/type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/receiver_wallet/wallet/deep_link_schema to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/receiver_wallet/wallet/enabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/receiver_wallet/wallet/sep_10_client_domain to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/receiver_wallet/wallet/user_managed to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dc42844e575d23See the full diff
    • ●

      added the new CANCELED enum value to the data/items/payment/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new CANCELED enum value to the data/items/payment/status_history/items/status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the media type */* for the response with the status 401

      response-media-type-added

    • ○

      added the media type */* for the response with the status 403

      response-media-type-added

    • ○

      added the media type */* for the response with the status 404

      response-media-type-added

  • 2b94ab61347411See the full diff
    • ●

      removed the optional property data/items/receiver_wallet/last_sms_sent from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property data/items/receiver_wallet/last_message_sent_at to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog