You can schedule when your sub-entities receive their funds using our Platforms solution. Use this endpoint to retrieve information about a sub-entity's schedule.
Schedule retrieved successfully
Unauthorized.
Sub-entity not found, or scheduled payouts are not available to the sub-entity.
Invalid data sent.
Too many requests.
// For more information please refer to https://github.com/checkout/checkout-sdk-net using Checkout.Accounts.Payout.Response; ICheckoutApi api = CheckoutSdk.Builder().OAuth() .ClientCredentials("client_id", "client_secret") .Scopes(OAuthScope.Accounts) .Environment(Environment.Sandbox) .EnvironmentSubdomain("{prefix}") // Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see https://www.checkout.com/docs/developer-resources/api/api-endpoints. .HttpClientFactory(new DefaultHttpClientFactory()) .Build(); try { GetScheduleResponse response = await api.AccountsClient().RetrievePayoutSchedule("entity_id"); } catch (CheckoutApiException e) { // API error string requestId = e.RequestId; var statusCode = e.HttpStatusCode; IDictionary<string, object> errorDetails = e.ErrorDetails; } catch (CheckoutArgumentException e) { // Bad arguments } catch (CheckoutAuthorizationException e) { // Invalid authorization }
{- "GBP": {
- "recurrence": {
- "enabled": true,
- "threshold": 100,
- "payment_instrument_id": "ppi_w4jelhppmfiufdnatam37wrfc4",
- "schedule": {
- "frequency": "weekly",
- "by_day": [
- "monday"
]
}
}, - "_links": {
}
}
}You can schedule when your sub-entities receive their funds using our Platforms solution. Use this endpoint to update a sub-entity's schedule.
Schedule updated successfully
Unauthorized
Unprocessable entity
Too many requests
{- "ISO": {
- "enabled": true,
- "threshold": 100,
- "payment_instrument_id": "ppi_w4jelhppmfiufdnatam37wrfc4",
- "recurrence": {
- "frequency": "weekly",
- "by_day": [
- "monday"
]
}
}
}{- "_links": {
}
}