> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plane.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a payment

> To send funds to a worker on Plane, you create a new payment object.

### Parameters

<ParamField body="worker" type="string" required>
  The ID of an existing worker this payment will be sent to.
</ParamField>

<ParamField body="amount" type="string" required>
  The amount of the payment in decimal format.
</ParamField>

<ParamField body="currency" type="string" required>
  Three-letter ISO currency code, in uppercase.
</ParamField>

<ParamField body="account" type="string">
  ID of the account belong to this worker you want to send the payment to. When omitted, Plane will
  use the worker's preferred bank account for a given currency.
</ParamField>

<ParamField body="date" type="string">
  The date this payment is scheduled for. When omitted, Plane will pick the soonest available date.
</ParamField>

<ParamField body="metadata" type="object">
  Set of key-value pairs that you can attach to an object. This can be useful for storing additional
  information about the object in a structured format.
</ParamField>

<ParamField body="reference" type="string">
  A reference for this payment visible to the worker. When ommitted, Plane will generate a new
  8-character reference for each payment.
</ParamField>

<ParamField body="note" type="string">
  An additional memo to be included with the payment. Plane will try to include it in payment
  instructions, so it may be shown on the recipient's bank statement depending on the payment method
  used.
</ParamField>

<ParamField body="period" type="object">
  An optional period that this payment is associated with.

  <Expandable title="child attributes">
    <ResponseField name="starts" type="string">
      The start of the period. This value is inclusive.
    </ResponseField>

    <ResponseField name="ends" type="string">
      The end of the period, which must be greater than or equal to the start. This value is
      inclusive.
    </ResponseField>
  </Expandable>
</ParamField>

### Returns

Returns the created payment ID. Retrieve the full
[Payment object](/reference/payments/object) with
[Get a payment](/reference/payments/get). Returns an error code if create
parameters are invalid.

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "pt_ogdEjSnSqNYxtW1sd3pC3hFX"
  }
  ```
</ResponseExample>