API reference · Getting paid

Collection terminals

POST/collector/terminal/{reference}/reinstateReinstate a suspended terminal
POST/collector/terminal/{reference}/suspendSuspend a terminal
POST/collector/{reference}/terminalRegister a device that may take collections for this collector
GET/collector/{reference}/terminalsList a collector's terminals

POST Reinstate a suspended terminal

POST /collector/terminal/{reference}/reinstate

The counterpart to suspension, for a handset that was recovered.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseTerminalResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "collectorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "terminalId": "string",
    "label": "string",
    "serialNumber": "string",
    "model": "string",
    "status": "string",
    "registeredAt": "string",
    "lastSeenAt": "string"
  },
  "description": "Terminal reinstated successfully"
}

Responses

Status	When
`200`	Terminal reinstated successfully

POST Suspend a terminal

POST /collector/terminal/{reference}/suspend

How a collector stops a lost or compromised handset from putting more collections onto the platform. Work the device signed before the suspension is not repudiated by it - an operator adjudicates that - but it may take no more.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseTerminalResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "collectorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "terminalId": "string",
    "label": "string",
    "serialNumber": "string",
    "model": "string",
    "status": "string",
    "registeredAt": "string",
    "lastSeenAt": "string"
  },
  "description": "Terminal suspended successfully"
}

Responses

Status	When
`200`	Terminal suspended successfully

POST Register a device that may take collections for this collector

POST /collector/{reference}/terminal

A handset that accepts money offline holds the platform's liability until it uploads, so it has to be a device somebody enrolled and can suspend. Registering the device's public key binds uploads to the handset that signed them: a payload carrying the right device identifier but a different key is refused. Registering the same device identifier again updates the record rather than creating a second one, so a re-keyed handset is a rotation and not a new terminal.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: RegisterTerminalRequest · Response: GenericResponseTerminalResponse

curl -X POST "https://api.bridgemoni.com/collector/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/terminal" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "terminalId": "string",
  "label": "string",
  "serialNumber": "string",
  "model": "string",
  "publicKey": "string"
}'

{
  "terminalId": "string",
  "label": "string",
  "serialNumber": "string",
  "model": "string",
  "publicKey": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "collectorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "terminalId": "string",
    "label": "string",
    "serialNumber": "string",
    "model": "string",
    "status": "string",
    "registeredAt": "string",
    "lastSeenAt": "string"
  },
  "description": "Terminal registered successfully"
}

Responses

Status	When
`200`	Terminal registered successfully

GET List a collector's terminals

GET /collector/{reference}/terminals

Each terminal carries when it was last seen, which is the only signal a platform has that a handset holding offline collections has gone quiet.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseListTerminalResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "collectorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "terminalId": "string",
      "label": "string",
      "serialNumber": "string",
      "model": "string",
      "status": "string",
      "registeredAt": "string",
      "lastSeenAt": "string"
    }
  ],
  "description": "Terminals retrieved successfully"
}

Responses

Status	When
`200`	Terminals retrieved successfully

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