Retrieve a Disbursement

GET 
/disbursements/:id

Fetches information on a specific disbursement by id .

Request

Path Parameters

id stringrequired

ID of the Disbursement.

Responses

200

Disbursement details

application/json

Schema

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

Example (from schema)

{
  "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.",
  "registration_contact_type": "EMAIL",
  "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": "DRAFT",
  "verification_field": "DATE_OF_BIRTH",
  "status_history": [
    {
      "user_id": "3f351b9e-ed0f-40fa-a314-14757b42dab1",
      "status": "DRAFT",
      "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"
}

401

Unauthorized

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Example

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

Example

{
  "error": "Forbidden"
}

404

Not Found

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not found",
  "extras": {
    "status": 404,
    "message": "Disbursement not found"
  }
}

Example

{
  "error": "Not found",
  "extras": {
    "status": 404,
    "message": "Disbursement not found"
  }
}

Loading...