Saltar al contenido principal

List All Disbursements

GET 
/disbursements

Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement.

Request​

Query Parameters

    page number

    Default value: 1

    The page requested.

    page_limit number

    Default value: 20

    Define how many results will be returned in the response.

    q string

    A search term used to query through the disbursement names.

    status string

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

    Exact match on the status of the disbursement.

    Example: DRAFT
    created_at_after string

    Only return disbursements that are created after this date. Format: YYYY-MM-DD

    Example: 2006-01-02
    created_at_before string

    Only return disbursements that are created before this date. Format: YYYY-MM-DD

    Example: 2006-01-02
    sort string

    Possible values: [name, created_at]

    Default value: created_at

    Field used to sort disbursements

    direction string

    Possible values: [asc, desc]

    Default value: asc

    Direction for sorting disbursements.

Responses​

A list of Disbursement details

Schema

    pagination

    object

    next string
    prev string
    pages integer
    total integer

    data

    object[]

  • Array [

    • id string

    The unique identifier of the disbursement

    name string

    The name of the disbursement

    receiver_registration_message_template string

    The custom template used to send invitations to receivers. The default message isn't returned. In the message's content it's possible to add the following template variables: {{.OrganizationName}} which is the Organization Name configured and {{.RegistrationLink}} which is the link generated by SDP to send to the receiver (in case this is not present in the message, it's automatically appended at the end).

    registration_contact_type RegistrationContactType (string)

    Possible values: [EMAIL, PHONE_NUMBER, EMAIL_AND_WALLET_ADDRESS, PHONE_NUMBER_AND_WALLET_ADDRESS]

    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, YEAR_MONTH, 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...