POST
/
payment-requests
/
{id}
/
decline

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.

Was this page helpful?

Approve a payment requestPay a payment request