GET
/
payments
/
{id}
curl --request GET \
  --url https://api.plane.com/v1/payments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "pt_KhzQL81YnE3B7K6MZb65gCJx",
  "worker": "wr_CgcLakmx4guire",
  "date": "2023-10-31",
  "amount": "12000.0",
  "currency": "USD",
  "status": "pending",
  "reference": "EFAK1ACH",
  "note": null,
  "period": {
    "starts": "2023-10-01",
    "ends": "2023-10-31"
  }
}

​
Parameters

​
id
string
required

The ID of a payment object.

​
Returns

Returns a payment if a valid identifier was provided, and returns an error otherwise.

{
  "id": "pt_KhzQL81YnE3B7K6MZb65gCJx",
  "worker": "wr_CgcLakmx4guire",
  "date": "2023-10-31",
  "amount": "12000.0",
  "currency": "USD",
  "status": "pending",
  "reference": "EFAK1ACH",
  "note": null,
  "period": {
    "starts": "2023-10-01",
    "ends": "2023-10-31"
  }
}

Was this page helpful?

List paymentsCancel a payment