Get Beneficiaries
Last updated
Last updated
GET {{baseUrl}}/beneficiaries/list
This endpoint retrieves a list of beneficiaries associated with the authenticated user. Beneficiaries are the recipients of payments or transfers, and their details are stored in the system for ease of transactions.
Headers
Authorization: Bearer YOUR_ACCESS_TOKEN
Request Body
No request body is required for this endpoint.
Example Response
The endpoint retrieves a list of beneficiaries.
The response for this request can be documented as a JSON schema:
{
"type": "object",
"properties": {
"status": {"type": "string"},
"status_code": {"type": "integer"},
"message": {"type": "string"},
"data": {
"type": "object",
"properties": {
"current_page": {"type": "integer"},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {"type": "integer"},
"user_id": {"type": "integer"},
"nickname": {"type": "string"},
"mode": {"type": "string"},
"currency": {"type": "string"},
"address": {
"type": "object",
"properties": {
"city": {"type": "string"},
"state": {"type": "string"},
"country": {"type": "string"},
"postal_code": {"type": "string"}
}
},
"beneficiary": {
"type": "object",
"properties": {
"name": {"type": "string"},
"email": {"type": "string"}
}
},
"payment_object": {
"type": "object",
"properties": {
"bank_name": {"type": "string"},
"bank_code": {"type": "string"},
"account_number": {"type": "string"},
"account_name": {"type": "string"}
}
},
"created_at": {"type": "string"},
"updated_at": {"type": "string"},
"deleted_at": {"type": ["string", "null"]}
}
}
},
"first_page_url": {"type": "string"},
"from": {"type": "integer"},
"last_page": {"type": "integer"},
"last_page_url": {"type": "string"},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {"type": ["string", "null"]},
"label": {"type": "string"},
"active": {"type": "boolean"}
}
}
},
"next_page_url": {"type": ["string", "null"]},
"path": {"type": "string"},
"per_page": {"type": "integer"},
"prev_page_url": {"type": ["string", "null"]},
"to": {"type": "integer"},
"total": {"type": "integer"}
}
}
}
}