API reference · Getting paid

Collectors

GET/collectorRead the collector you act for
POST/collector/{reference}/operatorAdd or re-role an operator
GET/collector/{reference}/operatorsList the operators of a collector
GET/collector/{reference}/pricingRead your rate card
POST/collector/{reference}/railEnable a collection rail
GET/collector/{reference}/railsList the rails a collector has enabled
GET/collector/{reference}/reserveRead your rolling reserve
POST/collector/{reference}/settlement-accountNominate a settlement account for a currency
GET/collector/{reference}/settlement-accountsList settlement accounts, one per currency

GET Read the collector you act for

GET /collector

Resolves the collector from your operator membership. A user who is an operator of no collector is refused rather than shown an empty result.

Headers

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

Example

Response: GenericResponseCollectorResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tradingName": "string",
    "displayName": "string",
    "statementDescriptor": "string",
    "merchantCategoryCode": "string",
    "jurisdictionCountryCode": "string",
    "status": "string",
    "underwritingDecision": "string",
    "marketplace": true,
    "parentCollectorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "kybVerifiedAt": "string",
    "activatedAt": "string",
    "suspendedAt": "string",
    "suspensionReason": "string"
  },
  "description": "Collector retrieved successfully"
}

Responses

Status	When
`200`	Collector retrieved successfully

POST Add or re-role an operator

POST /collector/{reference}/operator

Owner only. A collector must always keep at least one owner: demoting the last one is refused, because the settlement account would then be unchangeable except by support, which is the path an attacker wants.

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: AddCollectorOperatorRequest · Response: GenericResponseCollectorOperatorResponse

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

{
  "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "operatorRole": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "operatorRole": "string",
    "active": true
  },
  "description": "Operator added successfully"
}

Responses

Status	When
`200`	Operator added successfully

GET List the operators of a collector

GET /collector/{reference}/operators

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListCollectorOperatorResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "operatorRole": "string",
      "active": true
    }
  ],
  "description": "Operators retrieved successfully"
}

Responses

Status	When
`200`	Operators retrieved successfully

GET Read your rate card

GET /collector/{reference}/pricing

Every band, including superseded ones, newest first. Superseded rows are shown rather than hidden: a collector reconciling a statement from three months ago needs the rate that applied then, and a list of only the current rates cannot explain a historical fee.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListCollectorPricingResponse

curl -X GET "https://api.bridgemoni.com/collector/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/pricing" \
  -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",
      "railCode": "string",
      "currencyCode": "string",
      "cardBrand": "string",
      "minAmount": "string",
      "maxAmount": "string",
      "percentageRate": "string",
      "fixedAmount": "string",
      "capAmount": "string",
      "escrowUpliftPercentageRate": "string",
      "escrowUpliftFixedAmount": "string",
      "escrowUpliftCapAmount": "string",
      "feeBearer": "string",
      "refundFeeRebated": true,
      "refundFeeAmount": "string",
      "disputeFeeAmount": "string",
      "effectiveFrom": "string",
      "effectiveTo": "string",
      "approvedBy": "string",
      "belowCostReason": "string"
    }
  ],
  "description": "Rate card retrieved successfully"
}

Responses

Status	When
`200`	Rate card retrieved successfully

POST Enable a collection rail

POST /collector/{reference}/rail

Owner only. The rail must exist in the catalogue for that currency and country, and the collector must already have a settlement account in that currency - a rail that can take money the collector cannot be paid is a suspense generator.

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: EnableCollectorRailRequest · Response: GenericResponseCollectorRailResponse

curl -X POST "https://api.bridgemoni.com/collector/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/rail" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "railCode": "string",
  "currencyCode": "string",
  "countryCode": "string",
  "providerCode": "string",
  "settlementDelayHours": 0,
  "maxTransactionAmount": "string",
  "maxDailyAmount": "string",
  "payerBornePermitted": true
}'

{
  "railCode": "string",
  "currencyCode": "string",
  "countryCode": "string",
  "providerCode": "string",
  "settlementDelayHours": 0,
  "maxTransactionAmount": "string",
  "maxDailyAmount": "string",
  "payerBornePermitted": true
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "railCode": "string",
    "currencyCode": "string",
    "countryCode": "string",
    "providerCode": "string",
    "enabled": true,
    "settlementDelayHours": 0,
    "reservePercentage": "string",
    "escrowReserveDifferential": "string",
    "maxTransactionAmount": "string",
    "maxDailyAmount": "string",
    "payerBornePermitted": true
  },
  "description": "Rail enabled successfully"
}

Responses

Status	When
`200`	Rail enabled successfully

GET List the rails a collector has enabled

GET /collector/{reference}/rails

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListCollectorRailResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "railCode": "string",
      "currencyCode": "string",
      "countryCode": "string",
      "providerCode": "string",
      "enabled": true,
      "settlementDelayHours": 0,
      "reservePercentage": "string",
      "escrowReserveDifferential": "string",
      "maxTransactionAmount": "string",
      "maxDailyAmount": "string",
      "payerBornePermitted": true
    }
  ],
  "description": "Collector rails retrieved successfully"
}

Responses

Status	When
`200`	Collector rails retrieved successfully

GET Read your rolling reserve

GET /collector/{reference}/reserve

How much is held, how much has been returned, and - the question a collector actually asks - when the next tranche is due. A reserve reported without a release date is indistinguishable from a fee that was never disclosed.

Headers

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

Path parameters

Name
`reference`

Query parameters

Name	Default
`currencyCode`	Optional

Example

Response: GenericResponseCollectorReserveResponse

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

{
  "data": {
    "collectorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "currencyCode": "string",
    "accountNumber": "string",
    "heldAmount": "string",
    "releasedAmount": "string",
    "nextReleaseDueAt": "string",
    "nextReleaseAmount": "string"
  },
  "description": "Reserve retrieved successfully"
}

Responses

Status	When
`200`	Reserve retrieved successfully

POST Nominate a settlement account for a currency

POST /collector/{reference}/settlement-account

Owner only, one per currency. The account must belong to this collector's business, be held in that currency, and not be a pocket another module manages - settling into one of those corrupts that module's control totals.

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: NominateSettlementAccountRequest · Response: GenericResponseSettlementAccountResponse

curl -X POST "https://api.bridgemoni.com/collector/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/settlement-account" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "currencyCode": "string",
  "accountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "settlementMode": "string",
  "settlementDelayHours": 0
}'

{
  "currencyCode": "string",
  "accountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "settlementMode": "string",
  "settlementDelayHours": 0
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "currencyCode": "string",
    "accountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "accountNumber": "string",
    "settlementMode": "string",
    "settlementDelayHours": 0,
    "changePending": true,
    "pendingEffectiveAt": "string"
  },
  "description": "Settlement account nominated successfully"
}

Responses

Status	When
`200`	Settlement account nominated successfully

GET List settlement accounts, one per currency

GET /collector/{reference}/settlement-accounts

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListSettlementAccountResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "currencyCode": "string",
      "accountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "accountNumber": "string",
      "settlementMode": "string",
      "settlementDelayHours": 0,
      "changePending": true,
      "pendingEffectiveAt": "string"
    }
  ],
  "description": "Settlement accounts retrieved successfully"
}

Responses

Status	When
`200`	Settlement accounts retrieved successfully

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