Create customer partner residual

POST/workspaces/{organizationId}/customers/partner-residuals

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Request body

application/json

merchantsobject[]required

Show properties

Array of object

customerIdstringrequired

merchantNamestringrequired

partnerIdstringrequired

partnerNamestringrequired

monthlyCardVolumeCentsintegerrequired

min 0

monthlyAchCountintegerrequired

min 0

netCardMarginBpsnumber

netAchMarginCentsPerTxnumber

partnerRevSharePctnumber

min 0 · max 80

Responses

200

Computed monthly partner residual revenue-share payouts across referred merchants using Effect

totalMerchantsnumberrequired

totalVortexNetProfitCentsnumberrequired

totalPartnerResidualPayoutCentsnumberrequired

rowsobject[]required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://pile.nyc/workspaces/string/customers/partner-residuals' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "merchants": [
    {
      "customerId": "string",
      "merchantName": "string",
      "partnerId": "string",
      "partnerName": "string",
      "monthlyCardVolumeCents": 0,
      "monthlyAchCount": 0,
      "netCardMarginBps": 0,
      "netAchMarginCentsPerTx": 0,
      "partnerRevSharePct": 0
    }
  ]
}'

const response = await fetch("https://pile.nyc/workspaces/string/customers/partner-residuals", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"merchants\": [\n    {\n      \"customerId\": \"string\",\n      \"merchantName\": \"string\",\n      \"partnerId\": \"string\",\n      \"partnerName\": \"string\",\n      \"monthlyCardVolumeCents\": 0,\n      \"monthlyAchCount\": 0,\n      \"netCardMarginBps\": 0,\n      \"netAchMarginCentsPerTx\": 0,\n      \"partnerRevSharePct\": 0\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/customers/partner-residuals",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"merchants\": [\n    {\n      \"customerId\": \"string\",\n      \"merchantName\": \"string\",\n      \"partnerId\": \"string\",\n      \"partnerName\": \"string\",\n      \"monthlyCardVolumeCents\": 0,\n      \"monthlyAchCount\": 0,\n      \"netCardMarginBps\": 0,\n      \"netAchMarginCentsPerTx\": 0,\n      \"partnerRevSharePct\": 0\n    }\n  ]\n}",
)

Response

{
  "totalMerchants": 0,
  "totalVortexNetProfitCents": 0,
  "totalPartnerResidualPayoutCents": 0,
  "rows": [
    {
      "property1": null,
      "property2": null
    }
  ]
}