Bridge
Contact us
API reference · Getting paid

Collection requests

Bank transfer to account numbers, wallet, agent cash and offline devices, with split settlement and refunds. About collections Live

GET Read a receipt, with its charges decomposed

GET /collection/receipt/{reference}

The fee, the tax and the levy are three fields rather than one total, because they are owed to three different parties and a collector reconciling their own tax return needs the tax on its own. The rate-card row that priced it is named too, so a fee charged three months ago can be explained from the rate that was in force then rather than from the one in force now.

Headers

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

Path parameters

Name
reference

Example

Response: GenericResponseCollectionReceiptResponse

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

Responses

StatusWhen
200Receipt retrieved successfully

POST Create a collection request

POST /collection/request

Idempotent on your own reference: sending the same collectorOwnReference twice returns the first request rather than creating a second. Refused if you have no settlement account in that currency, because a request would otherwise take money the platform cannot pay you - and the discovery would happen after a payer had already paid.

Headers

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

Example

Request body: CreateCollectionRequestRequest · Response: GenericResponseCollectionRequestResponse

curl -X POST "https://api.bridgemoni.com/collection/request" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "form": "string",
  "collectorOwnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "currencyCode": "string",
  "countryCode": "string",
  "amountMode": "string",
  "amount": "string",
  "minAmount": "string",
  "maxAmount": "string",
  "requestDescription": "string",
  "usageMode": "string",
  "payerBinding": "string",
  "boundPayerReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "underpaymentPolicy": "string",
  "overpaymentPolicy": "string",
  "allowedRails": [
    "string"
  ],
  "returnUrl": "string",
  "expiresAt": "string",
  "metadata": "string",
  "splits": [
    {
      "recipientCollectorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "splitType": "string",
      "splitRole": "string",
      "percentage": "string",
      "fixedAmount": "string",
      "narrative": "string"
    }
  ]
}'

Responses

StatusWhen
200Collection request created successfully

GET Read one of your collection requests

GET /collection/request/{reference}

Headers

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

Path parameters

Name
reference

Example

Response: GenericResponseCollectionRequestResponse

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

Responses

StatusWhen
200Collection request retrieved successfully

POST Cancel an open collection request

POST /collection/request/{reference}/cancel

Deactivates every address so nothing new can be paid to it. A payment already in flight is still honoured when it lands - money that arrived is never rejected because a request was cancelled.

Headers

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

Path parameters

Name
reference

Example

Response: GenericResponseCollectionRequestResponse

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

Responses

StatusWhen
200Collection request cancelled successfully

GET List your collection requests

GET /collection/requests

Headers

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

Query parameters

NameDefault
page[object Object]
size[object Object]

Example

Response: GenericResponseCollectionRequestPageResponse

curl -X GET "https://api.bridgemoni.com/collection/requests?page=value&size=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200Collection requests retrieved successfully

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