Skip to main content

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

A list of Disbursement Receivers

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 ReceiversWalletStatus (string)

    Possible values: [DRAFT, READY, REGISTERED, FLAGGED]

    status_history

    object[]

  • Array [

  • status ReceiversWalletStatus (string)

    Possible values: [DRAFT, READY, REGISTERED, FLAGGED]

    timestamp date-time
  • ]

  • payment

    object

    id string
    amount string

    The amount of the payment

    stellar_transaction_id string

    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.

    circle_transfer_request_id string

    The Circle transfer request ID. It is only present when the payment was made using Circle.

    stellar_operation_id string
    status PaymentStatus (string)

    Possible values: [DRAFT, READY, PENDING, PAUSED, SUCCESS, FAILED]

    The status of the payment

    status_history

    object[]

    An aggregated list of metadata objects containing the statuses and the timestamp of when these status changes occurred.

  • Array [

  • status PaymentStatus (string)

    Possible values: [DRAFT, READY, PENDING, PAUSED, SUCCESS, FAILED]

    The status of the payment

    status_message string
    timestamp date-time
  • ]

  • disbursement

    object

    id uuid

    The unique identifier of the disbursement

    name string

    The name of the disbursement

    status DisbursementStatus (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

    The Stellar 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 ReceiversWalletStatus (string)

    Possible values: [DRAFT, READY, REGISTERED, FLAGGED]

    created_at date-time
    updated_at date-time
    created_at date-time
    updated_at date-time
  • ]

Loading...