CHcheckout
Payout schedules

Retrieve a sub-entity's payout schedule

You can schedule when your sub-entities receive their funds using our <a href="https://checkout.com/docs/platforms" target="_blank">Platforms solution</a>. Use this endpoint to retrieve information about a sub-entity's schedule.

get/accounts/entities/{id}/payout-schedules

Request

Path parameters

idstring required

The ID of the sub-entity

Response

Schedule retrieved successfully

OR

Example response

{
  "GBP": {
    "recurrence": {
      "enabled": true,
      "threshold": 100,
      "payment_instrument_id": "ppi_w4jelhppmfiufdnatam37wrfc4",
      "schedule": {
        "frequency": "weekly",
        "by_day": [
          "monday"
        ]
      }
    },
    "_links": {
      "self": {
        "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.