Bridge
Contact us
API reference · Getting paid

Agent cash collections

GET List cash collections

GET /collection/agent-cash

Defaults to what is still outstanding, because that is the figure a collector needs: money their agents are holding and have not paid in. Each row carries how far up the ageing ladder it has climbed.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Query parameters

NameDefault
statusOptional
pageOptional
sizeOptional

Example

Response: GenericResponseAgentCashPageResponse

curl -X GET "https://api.bridgemoni.com/collection/agent-cash" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200Cash collections retrieved successfully

GET Read one cash collection

GET /collection/agent-cash/{reference}

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseAgentCashResponse

curl -X GET "https://api.bridgemoni.com/collection/agent-cash/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200Cash collection retrieved successfully

POST Remit cash already collected

POST /collection/agent-cash/{reference}/remit

The moment the collector is credited. The amount is debited from the agent's own account, so remittance is the agent paying in what they hold rather than a bookkeeping entry, and only the agent who took the cash may remit it - letting anyone else would move the shortfall onto the wrong person. The receipt is value-dated to when the cash was taken, not to when it reached us.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseAgentCashResponse

curl -X POST "https://api.bridgemoni.com/collection/agent-cash/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/remit" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200Cash remitted successfully

POST Record cash an agent took for a collection

POST /collection/{reference}/collect/agent

Recording is not crediting. The agent has the notes and the platform has a claim on the agent, so the collector is not credited and the request is not paid until the cash is remitted. Booking it as a receipt at this point would put money on the collector's balance that nobody has actually handed over, and the shortfall would surface as an unexplainable settlement rather than as what it is - an agent who has not paid in.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
reference

Example

Request body: RecordAgentCashRequest · Response: GenericResponseAgentCashResponse

curl -X POST "https://api.bridgemoni.com/collection/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/collect/agent" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "agentOwnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "amount": "string",
  "terminalId": "string",
  "payerDisplayName": "string",
  "payerIdentifier": "string",
  "narration": "string",
  "collectedAt": "string"
}'

Responses

StatusWhen
200Cash collection recorded successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors