Skip to main content
PATCH
/
payment-request
/
{id}
/
decline
Decline Payment Request
curl --request PATCH \
  --url https://api.royalti.io/payment-request/{id}/decline \
  --header 'Authorization: Bearer <token>'
{
  "message": "Payment request declined successfully",
  "paymentRequest": {
    "id": "0654cd19-cea3-4fad-b92e-4033c4252c79",
    "status": "declined"
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

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

Code Examples

const response = await fetch('https://api.royalti.io/payment-request/example-id/decline', {
  method: 'PATCH',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
});

const data = await response.json();
console.log(data);

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Payment Request ID

Response

Success

message
string
paymentRequest
object