Skip to main content

Retrieve a Disbursement

GET 

/disbursements/:id

Fetches information on a specific disbursement by id .

Request

Path Parameters

    id stringrequired

    ID of the Disbursement.

Responses

Disbursement details

Schema

    id string

    The unique identifier of the disbursement

    name string

    The name of the disbursement

    country

    object

    code string

    Three-character ISO 3166 code

    name string

    Country name

    created_at date-time
    updated_at date-time

    wallet

    object

    id string
    name string
    homepage string
    sep_10_client_domain string
    deep_link_schema string
    created_at date-time
    updated_at date-time

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

    Possible values: [DRAFT, READY, STARTED, PAUSED, COMPLETED]

    verification_field VerificationField (string)

    Possible values: [DATE_OF_BIRTH, PIN, NATIONAL_ID_NUMBER]

    status_history

    object[]

  • Array [

  • user_id string
    status DisbursementStatus (string)

    Possible values: [DRAFT, READY, STARTED, PAUSED, COMPLETED]

    timestamp date-time
  • ]

  • file_name string
    created_at date-time
    updated_at date-time
    total_payments integer

    Total number of payments

    total_payments_sent integer

    Total number of successful payments

    total_payments_failed integer

    Total number of failed payments

    total_payments_remaining integer

    Total number of remaining payments

    amount_disbursed string

    The total amount disbursed so far

    total_amount string

    The total amount to be disbursed

    average_amount string

    The average amount per payment

Loading...