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

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.

​
Parameters

​
worker
string
required
The ID of the worker submitting or receiving this payment request.
​
amount
string
required
The requested amount in decimal format.
​
currency
string
required
Three-letter ISO currency code, in uppercase.
​
reference
string
Optional external reference, such as an invoice number.
​
note
string
Optional memo attached to the request.
​
period
object
Optional period this request is associated with.

​
Returns

Returns the created payment request ID. Retrieve the full Payment Request object with Get a payment request. 
{
  "id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX"
}