Skip to main content
GET
/
payment-requests
List payment requests
curl --request GET \
  --url https://api.natural.co/payment-requests \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "paymentRequest",
      "id": "prq_550e8400e29b41d4a716446655440000",
      "attributes": {
        "amount": 2500,
        "currency": "USD",
        "status": "OPEN",
        "description": "Invoice 7",
        "requesterName": "Acme Payments",
        "requesterEmail": "billing@acmepayments.com",
        "payerName": "Ada Lovelace",
        "payerEmail": "ada@example.com",
        "payerPhone": null,
        "payerPartyId": null,
        "payerIdentifierType": "email",
        "payerIdentifier": "ada@example.com",
        "paymentLinkUrl": "https://natural.co/paymentLink/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": null
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "hasMore": false,
      "nextCursor": null
    }
  }
}

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

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

Query Parameters

limit
integer
default:50

Results per page (1-100)

Required range: 1 <= x <= 100
cursor
string

Pagination cursor returned by the previous response

Response

Successful Response

data
PaymentRequestResource · object[]
required
meta
object
required