Skip to main content
POST
/
v1
/
payments
Create a payment
curl --request POST \
  --url https://api.plane.com/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "worker": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "account": "<string>",
  "date": "<string>",
  "metadata": {},
  "reference": "<string>",
  "note": "<string>",
  "period": {}
}
'
{
  "id": "pt_ogdEjSnSqNYxtW1sd3pC3hFX"
}

​
Parameters

​
worker
string
required
The ID of an existing worker this payment will be sent to.
​
amount
string
required
The amount of the payment in decimal format.
​
currency
string
required
Three-letter ISO currency code, in uppercase.
​
account
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.
​
date
string
The date this payment is scheduled for. When omitted, Plane will pick the soonest available date.
​
metadata
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.
​
reference
string
A reference for this payment visible to the worker. When ommitted, Plane will generate a new 8-character reference for each payment.
​
note
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.
​
period
object
An optional period that this payment is associated with.

​
Returns

Returns the created payment ID. Retrieve the full Payment object with Get a payment. Returns an error code if create parameters are invalid. 
{
  "id": "pt_ogdEjSnSqNYxtW1sd3pC3hFX"
}