v11

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-017364211.0 KB

Disbursements

Deletes a Draft Disbursement

Deletes a Disbursement in Draft or Ready Status by id.

delete/disbursements/{id}

Path parameters

idstring required

ID of the Disbursement.

Response

Deleted Disbursement details

idstring

The unique identifier of the disbursement

namestring

The name of the disbursement

receiver_registration_message_templatestring

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'EMAIL' | 'PHONE_NUMBER' | 'EMAIL_AND_WALLET_ADDRESS' | 'PHONE_NUMBER_AND_WALLET_ADDRESS'

status'DRAFT' | 'READY' | 'STARTED' | 'PAUSED' | 'COMPLETED'

verification_field'DATE_OF_BIRTH' | 'YEAR_MONTH' | 'PIN' | 'NATIONAL_ID_NUMBER'

file_namestring

created_atstring date-time

updated_atstring date-time

total_paymentsinteger

Total number of payments

total_payments_sentinteger

Total number of successful payments

total_payments_failedinteger

Total number of failed payments

total_payments_remaininginteger

Total number of remaining payments

amount_disbursedstring

The total amount disbursed so far

total_amountstring

The total amount to be disbursed

average_amountstring

The average amount per payment

Example response

{
  "id": "619da857-8725-4c58-933d-c120a458e0f5",
  "name": "Disbursement Name",
  "receiver_registration_message_template": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.",
  "wallet": {
    "id": "5ada9ed5-455a-4782-a0ee-160767e0deb1",
    "name": "Vibrant Assist",
    "homepage": "https://vibrantapp.com",
    "sep_10_client_domain": "api-dev.vibrantapp.com",
    "deep_link_schema": "https://vibrantapp.com/sdp-dev",
    "created_at": "2023-07-31T20:50:45.648Z",
    "updated_at": "2023-07-31T20:50:45.648Z"
  },
  "asset": {
    "id": "ffaec4b3-46b0-4db4-a4c4-6c3508057705",
    "code": "USDC",
    "issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
    "created_at": "2023-02-03T10:45:51Z",
    "updated_at": "2023-02-03T10:45:51Z",
    "deleted_at": "2023-06-03T10:55:51Z"
  },
  "status_history": [
    {
      "user_id": "3f351b9e-ed0f-40fa-a314-14757b42dab1",
      "timestamp": "2023-02-03T10:45:51Z"
    }
  ],
  "file_name": "disbursement-feb-03-2023.csv",
  "created_at": "2023-02-03T10:45:51Z",
  "updated_at": "2023-02-03T10:45:51Z",
  "total_payments": 10,
  "total_payments_sent": 8,
  "total_payments_failed": 1,
  "total_payments_remaining": 1,
  "amount_disbursed": "800.00",
  "total_amount": "1000.00",
  "average_amount": "100.00"
}