Saltar al contenido principal

Create Disbursement

POST 
/disbursements

Creates a new disbursement in draft state with basic details. Important: a disbursement is not triggered until the organization adds receivers through the Upload Disbursement Instructions endpoint and the status changes from draft to ready .

Request​

Body

    name string
    wallet_id string
    asset_id string
    verification_field VerificationField (string)

    Possible values: [DATE_OF_BIRTH, YEAR_MONTH, PIN, NATIONAL_ID_NUMBER]

    registration_contact_type RegistrationContactType (string)

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

    receiver_registration_message_template string

Responses​

A new disbursement

Schema

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