Listar dispersiones
curl --request GET \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/treasury/payouts \
--header 'api_access_token: <api-key>'const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/treasury/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/treasury/payouts"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"counts": {},
"summary": {
"next_date": "2023-12-25"
},
"meta": {
"total_count": 123,
"current_page": 123,
"page": 123,
"total_pages": 123,
"payout_days": [
123
]
},
"payload": [
{
"id": 123,
"role": "owner",
"status": "awaiting_approval",
"channel": "<string>",
"currency": "<string>",
"reference": "<string>",
"recipient_type": "Contact",
"recipient_id": 123,
"amount": "<string>",
"scheduled_on": "2023-12-25",
"closed_at": "2023-11-07T05:31:56Z",
"external_reference": "<string>",
"recipient_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"sent_on": "2023-12-25",
"hold_reason": "<string>",
"disbursed_at": "2023-11-07T05:31:56Z",
"approval": {
"approved_at": "2023-11-07T05:31:56Z",
"approved_amount": "<string>",
"approved_by": {
"id": 123,
"name": "<string>"
}
},
"came_back_reason": "<string>",
"scheduled_on_overridden": true,
"reschedules": [
{
"at": "2023-11-07T05:31:56Z",
"by_id": 123,
"by_name": "<string>",
"from": "2023-12-25",
"to": "2023-12-25",
"reason": "<string>"
}
]
}
]
}{}{}{}Treasury Payouts
Listar dispersiones
Lista todas las dispersiones abiertas y las selladas que se enviaron en el periodo elegido. counts agrupa por rol antes del filtro de rol; los totales de summary sí aplican el filtro de rol. Estado, canal, día de pago y paginación acotan payload. Requiere disbursements.view.
GET
/
api
/
v1
/
accounts
/
{account_id}
/
treasury
/
payouts
Listar dispersiones
curl --request GET \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/treasury/payouts \
--header 'api_access_token: <api-key>'const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/treasury/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/treasury/payouts"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"counts": {},
"summary": {
"next_date": "2023-12-25"
},
"meta": {
"total_count": 123,
"current_page": 123,
"page": 123,
"total_pages": 123,
"payout_days": [
123
]
},
"payload": [
{
"id": 123,
"role": "owner",
"status": "awaiting_approval",
"channel": "<string>",
"currency": "<string>",
"reference": "<string>",
"recipient_type": "Contact",
"recipient_id": 123,
"amount": "<string>",
"scheduled_on": "2023-12-25",
"closed_at": "2023-11-07T05:31:56Z",
"external_reference": "<string>",
"recipient_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"sent_on": "2023-12-25",
"hold_reason": "<string>",
"disbursed_at": "2023-11-07T05:31:56Z",
"approval": {
"approved_at": "2023-11-07T05:31:56Z",
"approved_amount": "<string>",
"approved_by": {
"id": 123,
"name": "<string>"
}
},
"came_back_reason": "<string>",
"scheduled_on_overridden": true,
"reschedules": [
{
"at": "2023-11-07T05:31:56Z",
"by_id": 123,
"by_name": "<string>",
"from": "2023-12-25",
"to": "2023-12-25",
"reason": "<string>"
}
]
}
]
}{}{}{}Authorizations
Query Parameters
Response
Dispersiones con conteos, totales por estado y paginación.