Payout schedules

View and manage payout schedules for your sub-entities.

Retrieve a sub-entity's payout schedule

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.

SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
path Parameters
id
required
string

The ID of the sub-entity

Example: ent_w4jelhppmfiufdnatam37wrfc4
Responses
200

Schedule retrieved successfully

401

Unauthorized.

404

Sub-entity not found, or scheduled payouts are not available to the sub-entity.

422

Invalid data sent.

429

Too many requests.

get/accounts/entities/{id}/payout-schedules
Request samples
// 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
}
Response samples
application/json
{}

Update a sub-entity's payout schedule

You can schedule when your sub-entities receive their funds using our Platforms solution. Use this endpoint to update a sub-entity's schedule.

SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
path Parameters
id
required
string

The ID of the sub-entity

Example: ent_w4jelhppmfiufdnatam37wrfc4
Request Body schema: application/json
required
object <ISO 4217> = 3 characters

The three-letter ISO currency code of the account's currency.

Responses
200

Schedule updated successfully

401

Unauthorized

422

Unprocessable entity

429

Too many requests

put/accounts/entities/{id}/payout-schedules
Request samples
application/json
{
  • "ISO": {
    }
}
Response samples
application/json