---
updatedAt: 2026-06-06T07:52:57.000Z
agentTools:
  projectIndex: https://developers.paygreen.fr/llms.txt
---

# Create Payout Schedule

Create a payout schedule to automate payouts.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Payment API",
    "description": "This API processes PayGreen V3 payment",
    "version": "1.46.3"
  },
  "servers": [
    {
      "url": "https://api.paygreen.fr",
      "description": "Production environment"
    },
    {
      "url": "https://sb-api.paygreen.fr",
      "description": "Sandbox environment"
    }
  ],
  "paths": {
    "/payment/payout-schedules": {
      "post": {
        "tags": [
          "Payout Schedule"
        ],
        "summary": "Create Payout Schedule",
        "description": "Create a payout schedule to automate payouts.",
        "operationId": "post_create_payout_schedule",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePayoutScheduleRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Payout Schedule successfully created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutSchedule2"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthenticated"
          },
          "403": {
            "description": "Forbidden"
          }
        },
        "security": [
          {
            "Bearer": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "CreatePayoutScheduleRequest": {
        "required": [
          "payment_config",
          "frequency",
          "billing_descriptor"
        ],
        "properties": {
          "payment_config": {
            "$ref": "#/components/schemas/PaymentConfig/properties/id"
          },
          "frequency": {
            "description": "The frequency of the payout schedule.",
            "type": "string",
            "enum": [
              "daily",
              "weekly",
              "monthly"
            ]
          },
          "billing_descriptor": {
            "description": "The billing descriptor for the payout schedule.",
            "type": "string",
            "example": "My Company"
          },
          "day": {
            "description": "The day of the week or month, required if the frequency is not daily.",
            "type": "integer",
            "maximum": 28,
            "minimum": 1
          }
        },
        "type": "object"
      },
      "PaymentConfig": {
        "required": [
          "id",
          "shop_id",
          "platform",
          "status",
          "created_at"
        ],
        "properties": {
          "id": {
            "description": "The unique identifier of this Payment Config",
            "type": "string",
            "pattern": "pc_[0-9a-f]{32}"
          },
          "object": {
            "type": "string",
            "default": "payment_config"
          },
          "shop_id": {
            "type": "string",
            "pattern": "sh_[0-9a-f]{32}"
          },
          "platform": {
            "type": "string",
            "enum": [
              "bank_card",
              "amex",
              "ancv",
              "swile",
              "mcv",
              "restoflash",
              "conecs",
              "apple_pay",
              "edenred",
              "google_pay",
              "bancontact",
              "klarna"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "pending",
              "validated",
              "enabled",
              "disabled",
              "deleted",
              "invalid"
            ]
          },
          "currency": {
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/Currency"
              }
            ]
          },
          "selling_contract": {
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/SellingContract"
              }
            ]
          },
          "platform_options": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "type": "object"
      },
      "PayoutSchedule2": {
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "description": "The unique identifier of this Payout Schedule",
            "type": "string",
            "pattern": "ps_[0-9a-f]{32}"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "bearerFormat": "JWT",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "tags": [
    {
      "name": "Payout Schedule"
    }
  ]
}
```