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

200

A list of Disbursement details

application/json

Schema

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

Example (from schema)

{
  "pagination": {
    "next": "/disbursements?page=3&page_limit=1",
    "prev": "/disbursements?page=1&page_limit=1",
    "pages": 4,
    "total": 4
  },
  "data": {
    "id": "619da857-8725-4c58-933d-c120a458e0f5",
    "name": "Disbursement Name",
    "country": {
      "code": "UKR",
      "name": "Ukraine",
      "created_at": "2023-02-03T10:45:51.000Z",
      "updated_at": "2023-02-03T10:45:51.000Z"
    },
    "wallet": {
      "id": "e2de8544-b7e2-40a9-ad40-411f70d5c4bf",
      "name": "Vibrant",
      "homepage": "https://vibrantapp.com"
    },
    "asset": {
      "id": "25923001-508a-4629-9186-c41211b2a3d0",
      "code": "USDC",
      "issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
    },
    "status": "READY",
    "verification_field": "DATE_OF_BIRTH",
    "status_history": [
      {
        "user_id": null,
        "status": "DRAFT",
        "timestamp": "2023-02-03T10:45:51.000Z"
      },
      {
        "user_id": "2ec7f1f9-add3-4e6d-9d14-bd8ac5e88872",
        "status": "READY",
        "timestamp": "2023-02-03T10:45:51.000Z"
      }
    ],
    "file_name": "disbursement-february-03-2023.csv",
    "created_at": "2023-02-03T10:45:51.000Z",
    "updated_at": "2023-02-03T10:45:51.000Z",
    "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

Response Headers

application/json

Schema

Schema

error string
extras object
status number
message string

Example (from schema)

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

response

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

403

Forbidden

Response Headers

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

response

{
  "error": "Forbidden"
}

Loading...