POST
/
payment-requests
/
{id}
/
decline
Decline a payment request
curl --request POST \
  --url https://api.plane.com/v1/payment-requests/{id}/decline \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "approver": "<string>",
  "reason": "<string>",
  "correctable": "<string>"
}'
{
  "id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
  "worker": "wr_anqRSFcK36ie85",
  "amount": "1200.00",
  "currency": "EUR",
  "status": "declined",
  "reference": "EV1S3GDM",
  "note": "Payment for July",
  "period": {
    "starts": "2023-07-01",
    "ends": "2023-07-31"
  },
  "documents": [],
  "approvals": ["apr_YzmQ5oxQE78bDV3fZwEU3vGr"],
  "payment": null
}
Declines a payment request and sends it back to the worker.

​
Parameters

​
id
string
required
The ID of the payment request you are declining.
​
approver
string
required
The ID of the person declining this request.
​
reason
string
required
A description of why the request was declined, visible to the worker.
​
correctable
string
default:"true"
Whether the worker is asked to correct their request. Defaults to true. When false, the request will be permanently declined.Note: Permanently declining a request won’t prevent the worker from submitting a new request.

​
Returns

Returns the Payment Request object with a new approval. 
{
  "id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
  "worker": "wr_anqRSFcK36ie85",
  "amount": "1200.00",
  "currency": "EUR",
  "status": "declined",
  "reference": "EV1S3GDM",
  "note": "Payment for July",
  "period": {
    "starts": "2023-07-01",
    "ends": "2023-07-31"
  },
  "documents": [],
  "approvals": ["apr_YzmQ5oxQE78bDV3fZwEU3vGr"],
  "payment": null
}