Mosend
MosendDeveloper

saldo

Referencia de 4 endpoints generados desde mosend-wb-backend/src/modules/saldo/saldo.controller.ts.

Base path: /organizations/:orgId/saldo·4 endpoints·Source: mosend-wb-backend/src/modules/saldo/saldo.controller.ts
GET/organizations/:orgId/saldo/:contactId
bearer

Saldo a favor del cliente: total por moneda y bolsillos por marca

Path params

  • orgIdstringrequerido
  • contactIdstringrequerido

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/saldo/00000000-0000-0000-0000-000000000000' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
GET/organizations/:orgId/saldo/:contactId/movimientos
bearer

Movimientos del saldo del cliente, del más nuevo al más viejo

Path params

  • orgIdstringrequerido
  • contactIdstringrequerido

Query params

  • antesstring
  • limitenumber

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/saldo/00000000-0000-0000-0000-000000000000/movimientos' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2026-05-01T03:42:18.123Z"
    }
  ],
  "timestamp": "2026-05-01T03:42:18.123Z"
}
POST/organizations/:orgId/saldo/:contactId/ajuste
bearer

Abona o descuenta saldo a mano, con motivo (permiso saldo:gestionar)

Path params

  • orgIdstringrequerido
  • contactIdstringrequerido

Body (JSON)

  • montoCentsnumberrequerido

    En centavos. Positivo abona, negativo descuenta.

  • currencystringrequerido
    COPUSDEURMXNPENCLPARSBRL
  • perfilDeCobroIdstring · uuid

    Marca (perfil de cobro) del bolsillo; sin ella, el bolsillo general.

  • motivostringrequerido

Respuestas

  • 201
curl -X POST 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/saldo/00000000-0000-0000-0000-000000000000/ajuste' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"montoCents": 0,"currency": "COP","perfilDeCobroId": "00000000-0000-0000-0000-000000000000","motivo": "<motivo>"}'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
POST/organizations/:orgId/saldo/:contactId/devolucion
bearer

Registra que se le devolvió saldo en dinero (la plata se transfiere por fuera; permiso saldo:gestionar)

Path params

  • orgIdstringrequerido
  • contactIdstringrequerido

Body (JSON)

  • saldoIdstring · uuidrequerido

    El bolsillo del que sale (id de `bolsillos[]`).

  • montoCentsnumberrequerido
  • motivostring

Respuestas

  • 201
curl -X POST 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/saldo/00000000-0000-0000-0000-000000000000/devolucion' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"saldoId": "00000000-0000-0000-0000-000000000000","montoCents": 0,"motivo": "<motivo>"}'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}