This page covers the two profit share reconciliation endpoints. For background on when and why to use them, see Reconciliation.

List profit share recon records

GET /v3/funds/allocations/profit-share returns a paginated list of service fee distribution records for your organisation hierarchy.

Required parameters

Parameter	Type	Description
`dateTimeFrom`	date-time	Inclusive lower bound (ISO 8601)
`dateTimeTo`	date-time	Exclusive upper bound (ISO 8601)

Optional filters

Parameter	Type	Description
`fundsOrganisationId`	uuid	Filter to a specific organisation in your hierarchy
`limit`	integer (1–100)	Number of records per page
`startingAfter`	uuid	Cursor for forward pagination
`endingBefore`	uuid	Cursor for backward pagination

Example request

GET /v3/funds/allocations/profit-share?dateTimeFrom=2024-01-01T00:00:00Z&dateTimeTo=2024-02-01T00:00:00Z&limit=25

Example response

{
  "hasMore": true,
  "data": [
    {
      "fundsAllocationId": "b7e9c4a2-8f31-4d6e-a529-3c7b8e1f0d42",
      "quoteId": "a6711057-1b63-41e0-81c3-24c02c5ef63b",
      "fundsDateTime": "2024-01-15T14:30:00Z",
      "consumerReference": "consumer_123",
      "fundsOrganisationId": "2f6d6b1f-1c6a-4e9a-9c15-7b8a0db1a2c3",
      "fundsOrganisationReference": "MID12345",
      "billingOrganisationId": "9e1d3a52-0e3d-4a9f-8b6e-1c2d3e4f5a6b",
      "fundsCurrencyCode": "GBP",
      "reversal": false,
      "taxLiability": "platform",
      "amounts": {
        "total": 12.60,
        "impact": 10.00,
        "impactTax": 0.00,
        "serviceFee": 2.00,
        "serviceFeeTax": 0.40
      },
      "merchant": {
        "name": "Blossom & Bloom",
        "mcc": "5992"
      },
      "profitShareAllocations": [
        {
          "beneficiaryOrganisationId": "9e1d3a52-0e3d-4a9f-8b6e-1c2d3e4f5a6b",
          "beneficiaryOrganisationReference": "PSP_001",
          "billingCurrencyCode": "USD",
          "billingCurrencyExchangeRate": 1.27,
          "amounts": {
            "profitShare": 0.11,
            "profitShareTax": 0.003,
            "profitShareTaxRate": 0.20
          }
        },
        {
          "beneficiaryOrganisationId": "4ab96e75-6828-5673-c4ed-3d074e77beb7",
          "beneficiaryOrganisationReference": "EKKO",
          "billingCurrencyCode": "GBP",
          "billingCurrencyExchangeRate": 1.00,
          "amounts": {
            "profitShare": 0.22,
            "profitShareTax": 0.006,
            "profitShareTaxRate": 0.20
          }
        }
      ]
    }
  ]
}

See the List profit share recon records endpoint for the full response schema.

Get a single profit share recon record

GET /v3/funds/allocations/{id}/profit-share returns the profit share recon record for a single funds allocation. The response is the same structure as a single item from the list endpoint's data array, without the hasMore wrapper.

Example request

GET /v3/funds/allocations/b7e9c4a2-8f31-4d6e-a529-3c7b8e1f0d42/profit-share