Skip to main content

Create Disbursement​

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
  • country_code string

    Three-character ISO 3166 code

Responses

A new disbursement

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
  • id string
  • code string

    Asset code

  • issuer string

    Asset issuer address

  • created_at date-time
  • updated_at date-time
  • deleted_at date-time
  • status string

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

    The status of the disbursement

  • verification_field string

    Possible values: [DATE_OF_BIRTH, PIN, NATIONAL_ID_NUMBER]

  • status_history object[]
  • Array [
  • user_id string
  • status 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...