Custom Data
Reference guide for using the custom_data array to enable MID Group routing and Split Payments.
Custom Data
API Version: 3.0.0
The custom_data array in the Payment Request API enables MID Group routing and Split Payments. Each array element is an object with a single key (alpha, beta, gamma, delta, or epsilon).
Navigate to Developers → API Keys → Add new API key → Select Hosted Solution in the Channel Dropdown to generate your API credentials.
Overview
custom_data is part of the request body at:
POST https://api.payorc.com/orders/v1/create
"custom_data": [
{ "alpha": "MID_GROUP" },
{ "beta": "INS_HEALTH" },
{ "gamma": "" },
{ "delta": "" },
{ "epsilon": "" }
]custom_data must be an array of objects — not a single JSON object. The same array format applies to parameters.
MID Group Routing
Route a transaction to a specific merchant account group configured in the Merchant Portal.
| Array element | Value format | Example | Description |
|---|---|---|---|
{ "alpha": "..." } | MID_GROUP | "MID_GROUP" | Enables MID Group routing |
{ "beta": "..." } | {label} | "INS_HEALTH" | MID Group label from Merchant Portal |
{ "gamma": "..." } | "" | "" | Reserved |
{ "delta": "..." } | "" | "" | Reserved |
{ "epsilon": "..." } | "" | "" | Reserved |
"custom_data": [
{ "alpha": "MID_GROUP" },
{ "beta": "INS_HEALTH" },
{ "gamma": "" },
{ "delta": "" },
{ "epsilon": "" }
]See the MID Group page for a full request example.
Split Payments
Distribute a transaction payout across multiple accounts. Live mode only.
| Array element | Value format | Example | Description |
|---|---|---|---|
{ "alpha": "..." } | |SPLIT_PAYMENT | "|SPLIT_PAYMENT" | Enables split payment mode |
{ "beta": "..." } | |{id},{type},{value} | "|100,P,2" | 2% to Split ID 100 |
{ "gamma": "..." } | |{id},{type},{value} | "|101,F,50" | Flat 50 to Split ID 101 |
{ "delta": "..." } | |{id},{type},{value} | "|102,F,25" | Flat 25 to Split ID 102 |
{ "epsilon": "..." } | |{id},{type},{value} | "|103,P,1" | 1% to Split ID 103 |
Split types: P = percentage of order amount, F = flat amount in order currency.
"custom_data": [
{ "alpha": "|SPLIT_PAYMENT" },
{ "beta": "|100,P,2" },
{ "gamma": "|101,F,50" },
{ "delta": "" },
{ "epsilon": "" }
]See the Split Payment page for a full request example.
MID Group + Split Payment (Combined)
When using both features together:
"custom_data": [
{ "alpha": "MID_GROUP|SPLIT_PAYMENT" },
{ "beta": "|INS_HEALTH|100,P,2" },
{ "gamma": "|INS_HEALTH|101,F,50" },
{ "delta": "" },
{ "epsilon": "" }
]alpha: pipe-separated flags —MID_GROUPand/orSPLIT_PAYMENTbeta–epsilon: pipe-separated values —{mid_group_label}|{split_id},{type},{value}
Parameters (Merchant Metadata)
Use parameters with the same array format to pass merchant-defined data echoed in webhooks:
"parameters": [
{ "alpha": "order-ref-123" },
{ "beta": "campaign-summer" },
{ "gamma": "" },
{ "delta": "" },
{ "epsilon": "" }
]