Retrieve a Disbursement
GET/disbursements/:id
Fetches information on a specific disbursement by id
.
Request
Path Parameters
ID of the Disbursement
.
Responses
- 200
- 401
- 403
- 404
Disbursement details
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
The unique identifier of the disbursement
The name of the disbursement
country
object
Three-character ISO 3166 code
Country name
wallet
object
asset
object
Asset code
Asset issuer address
Possible values: [DRAFT
, READY
, STARTED
, PAUSED
, COMPLETED
]
The status of the disbursement
Possible values: [DATE_OF_BIRTH
, PIN
, NATIONAL_ID_NUMBER
]
status_history
object[]
Possible values: [DRAFT
, READY
, STARTED
, PAUSED
, COMPLETED
]
Total number of payments
Total number of successful payments
Total number of failed payments
Total number of remaining payments
The total amount disbursed so far
The total amount to be disbursed
The average amount per payment
{
"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": "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:51.000Z",
"updated_at": "2023-02-03T10:45:51.000Z",
"deleted_at": "2023-06-03T10:55:51.000Z"
},
"status": "READY",
"verification_field": "DATE_OF_BIRTH",
"status_history": [
{
"user_id": "3f351b9e-ed0f-40fa-a314-14757b42dab1",
"status": "DRAFT",
"timestamp": "2023-02-03T10:45:51.000Z"
}
],
"file_name": "disbursement-feb-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"
}
Unauthorized
Response Headers
- application/json
- Schema
- Example (from schema)
- response
Schema
extras
object
{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}
{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}
Forbidden
Response Headers
- application/json
- Schema
- Example (from schema)
- response
Schema
{
"error": "Forbidden"
}
{
"error": "Forbidden"
}
Not Found
Response Headers
- application/json
- Schema
- Example (from schema)
- response
Schema
extras
object
{
"error": "Not found",
"extras": {
"status": 404,
"message": "Disbursement not found"
}
}
{
"error": "Not found",
"extras": {
"status": 404,
"message": "Disbursement not found"
}
}