API reference · Getting paid

Collection splits

GET/collection/receipt/{reference}/splitsRead how one receipt was actually split
GET/collection/request/{reference}/splitsRead how a collection will be split

GET Read how one receipt was actually split

GET /collection/receipt/{reference}/splits

The amounts here are the ones that will settle, computed once when the money arrived and never recomputed - a split recalculated at settlement time could answer differently after a rate change. The rounding residue is carried on the row it was assigned to, so a recipient who is a minor unit up or down can be shown exactly why.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListReceiptSplitResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "receiptReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "recipientCollectorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "currencyCode": "string",
      "splitRole": "string",
      "sequenceNumber": 0,
      "amount": "string",
      "residueAmount": "string",
      "reversedAmount": "string"
    }
  ],
  "description": "Receipt splits retrieved successfully"
}

Responses

Status	When
`200`	Receipt splits retrieved successfully

GET Read how a collection will be split

GET /collection/request/{reference}/splits

Splits are declared when the request is created and frozen from that moment: they were disclosed to the recipients and a payer pays against them, so changing who gets what afterwards would be re-directing somebody else's money. Percentages are taken against the net, after the marketplace's own charges, which is why they can sum to a hundred without leaving the platform short.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListRequestSplitResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "requestReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "recipientCollectorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "splitType": "string",
      "splitRole": "string",
      "percentage": "string",
      "fixedAmount": "string",
      "sequenceNumber": 0,
      "narrative": "string"
    }
  ],
  "description": "Splits retrieved successfully"
}

Responses

Status	When
`200`	Splits retrieved successfully

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