Skip to main content
PATCH
/
payment-request
/
{id}
/
decline
Decline Payment Request
curl --request PATCH \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/payment-request/{id}/decline \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reason": "<string>"
}'
{
  "message": "Payment request declined successfully",
  "paymentRequest": {
    "id": "0654cd19-cea3-4fad-b92e-4033c4252c79",
    "status": "declined"
  }
}
Decline Payment Request Description:
The /payment-request/{id}/decline endpoint declines a specific payment request.
Method:
PATCH
Path Parameter:
ParameterTypeDescription
idstringThe unique identifier of the payment request

Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

Path Parameters

ParameterTypeInRequiredDescription
idstringpathāœ…Payment Request ID

Request Body

Request Schema

FieldTypeRequiredDescription
reasonstringāŒOptional reason for the decline

Responses

āœ… 200 - Success

āš ļø 401 - Unauthorized

āš ļø 404 - Not Found

āŒ 500 - Internal Server Error

Tags

Payment Requests

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string
required

Payment Request ID

Body

application/json
reason
string

Optional reason for the decline

Response

Success

message
string
paymentRequest
object
⌘I