Skip to main content
POST
/
payment-requests
/
{paymentRequestId}
/
decline
Decline payment request
curl --request POST \
  --url https://api.natural.co/payment-requests/{paymentRequestId}/decline \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>'
{
  "data": {
    "type": "paymentRequest",
    "id": "prq_550e8400e29b41d4a716446655440000",
    "attributes": {
      "amount": 500,
      "currency": "USD",
      "status": "DECLINED",
      "requesterName": "Natural Coffee",
      "requesterEmail": "billing@natural.test",
      "description": "Invoice 7",
      "payerName": "Ada Lovelace",
      "payerEmail": "ada@example.com",
      "payerPhone": "+14155550100",
      "payerPartyId": "pty_550e8400e29b41d4a716446655440000",
      "payerIdentifierType": "party_id",
      "payerIdentifier": "pty_550e8400e29b41d4a716446655440000",
      "paymentLinkUrl": "https://app.natural.test/pay/token_123",
      "transactionId": null,
      "createdAt": "2026-04-15T00:00:00.000Z",
      "updatedAt": "2026-04-15T00:00:00.000Z"
    },
    "relationships": {
      "requesterParty": {
        "data": {
          "type": "party",
          "id": "pty_019cd1798d617f65a79cb965dda9eac3"
        }
      },
      "wallet": {
        "data": {
          "type": "wallet",
          "id": "wal_550e8400e29b41d4a716446655440000"
        }
      },
      "payerParty": {
        "data": {
          "type": "party",
          "id": "pty_550e8400e29b41d4a716446655440000"
        }
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.natural.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string
required

Unique key for idempotent request handling. If a request with the same key was already processed, the original response is returned.

​
X-Agent-ID
string | null

Agent ID (agt_xxx) identifying which agent is making the request.

​
X-Instance-ID
string | null

Required when X-Agent-ID is present. Session or conversation ID for agent observability.

Maximum string length: 1024

Path Parameters

​
paymentRequestId
string
required
Pattern: ^prq_[0-9a-f]{32}$

Response

Successful Response

​
data
PaymentRequestResource · object
required