Reject Payment Request

post

https://api-sandbox.paymentlabs.io/payment-requests/received/{requestId}/reject

Rejects a payment request with a reason. The request moves to NOT_APPROVED.

The payee reads your reason, can edit the request and submit it again, which returns it to PENDING_APPROVAL. Only a
request that is PENDING_APPROVAL can be rejected; an approved request cannot.

Requires the Payment Requests permission (see List Received Payment Requests).

The response is the request as the payee sees it: it never carries amountOverride. Use Get Received Payment Request for
your own view.

Errors

400 INVALID_REJECTION_REASON: reason is missing, blank, or over 2000 characters
404 NOT_FOUND: no request with this ID was submitted to you
423 NOT_EDITABLE: the request is not PENDING_APPROVAL

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The request, now NOT_APPROVED.

400The request was understood but refused by a business rule. Read code to decide what to do; the possible codes are listed in the endpoint description. message is for humans and may change.

404The resource does not exist in your account.

423The resource is in a state that does not allow this change, for example a payment that has already been submitted or a batch that has been archived. Read the resource again to see its current state.