API reference · Getting paid

Collection reversals

POST/collection/receipt/{reference}/refundRefund a collection
GET/collection/receipt/{reference}/refundsList the refunds made on a collection
GET/collector/{reference}/disputesList the disputes raised against a collector
POST/dispute/{reference}/evidenceSubmit evidence against a dispute

POST Refund a collection

POST /collection/receipt/{reference}/refund

Checked against what remains unrefunded on the receipt, not against the original amount: two partial refunds of the full amount each pass on their own and together return twice what was collected. The money comes from holding if the collection has not settled, then the collector's account, then their reserve, then a debit balance if they are underwritten for one - and never from an overdraft. If none of those covers it the refund is refused and recorded as refused, rather than moving part of the money and leaving the payer half-repaid.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Idempotency-Key`	Reuse the same value on every retry of this request
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: CreateRefundRequest · Response: GenericResponseRefundResponse

curl -X POST "https://api.bridgemoni.com/collection/receipt/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/refund" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": "string",
  "reason": "string"
}'

{
  "amount": "string",
  "reason": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "orderReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "reason": "EVENT_CANCELLED",
    "faceAmount": "string",
    "feeAmount": "string",
    "currency": "string",
    "destinationKind": "string",
    "maskedDestination": "string",
    "status": "PENDING",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Refund completed successfully"
}

Responses

Status	When
`200`	Refund completed successfully

GET List the refunds made on a collection

GET /collection/receipt/{reference}/refunds

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListRefundResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "orderReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "reason": "EVENT_CANCELLED",
      "faceAmount": "string",
      "feeAmount": "string",
      "currency": "string",
      "destinationKind": "string",
      "maskedDestination": "string",
      "status": "PENDING",
      "creationDateTime": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Refunds retrieved successfully"
}

Responses

Status	When
`200`	Refunds retrieved successfully

GET List the disputes raised against a collector

GET /collector/{reference}/disputes

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListDisputeResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "ticketReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "status": "OPEN",
      "creationDateTime": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Disputes retrieved successfully"
}

Responses

Status	When
`200`	Disputes retrieved successfully

POST Submit evidence against a dispute

POST /dispute/{reference}/evidence

Before the scheme's deadline, which is not advisory - miss it and the dispute is lost whatever the merits.

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: SubmitDisputeEvidenceRequest · Response: GenericResponseDisputeResponse

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

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "ticketReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "OPEN",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Evidence submitted successfully"
}

Responses

Status	When
`200`	Evidence submitted successfully

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