Daily Gross Settlement Configuration

Prev Next

This Implementations resource provides steps to configure daily gross settlement.

Create a /billings Resource

This will determine what Fees are collected in a statement for a period of time. In this instance, you will want to establish a billing resource daily of 1 for Daily Gross Settlement. '

Associate a /billingEvents resource to the /billings resource.

This defines what will be collected in a statement. A /billingEvents can be set up for fees, chargebacks, returns, and profitShares. If the resource is for one specific item, then the eventSchedule must be set, otherwise the /billingEvents will apply for all items, meaning all fees opposed to just a specific fee.

Tip

Establish a fee Group and associate the billing event to the established group. That way, you then will only need to associate your new Merchant to the established group.

The following entity reference is defined as the entity that will be collecting the fees. In most cases, this would be the Partner of Worldpay for Platforms collecting fees from their Merchant. You can locate your entity ID within the Portal or inquire through Partner Integrations.

POST /billings HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: test-api.payrix.com
APIKEY: {apiKey} 
{
  "entity": "t1_ent_123abc4d567890efg1h2i34",
  "org": "t1_org_123abc4d567890efg1h2i34",
  "schedule": "days",
  "scheduleFactor": "1",
  "start": "20250624",
  "currency": "USD",
  "billingEvents": [
    {
      "event": "fees"
    }
  ]
}

Response:

{
    "response": {
        "data": [
            {
                "billingEvents": [
                    {
                        "id": "t1_ble_60d335745bf6cf570642c5e",
                        "created": "2021-06-23 09:21:56.3789",
                        "modified": "2021-06-23 09:21:56.3789",
                        "creator": "t1_log_60bf7b499027d6b3a259cd7",
                        "modifier": "t1_log_60bf7b499027d6b3a259cd7",
                        "billing": "t1_bil_60d335745ba32d61bf4cbe7",
                        "event": "fees",
                        "eventSchedule": null,
                        "deductFromBalance": 0,
                        "inactive": 0,
                        "frozen": 0
                    }
                ],
                "id": "t1_bil_60d335745ba32d61bf4cbe7",
                "created": "2021-06-23 09:21:56.3755",
                "modified": "2021-06-23 09:21:56.3755",
                "creator": "t1_log_60bf7b499027d6b3a259cd7",
                "modifier": "t1_log_60bf7b499027d6b3a259cd7",
                "login": "t1_log_60bf7b499027d6b3a259cd7",
                "entity": "t1_ent_5ec557f228740699e61e330",
                "org": "t1_org_5ec55828592a640ef2b3eb5",
                "division": null,
                "partition": null,
                "description": null,
                "schedule": "days",
                "scheduleFactor": 1,
                "start": "20210624",
                "finish": null,
                "collection": "entity",
                "collectionFactor": "days",
                "collectionOffset": 1,
                "collectionIncludeCurrent": "0",
                "currency": "USD",
                "inactive": 0,
                "frozen": 0,
                "forentity": null
            }
        ],
        "details": {
            "requestId": 1
        },
        "errors": []
    }
}