Skip to main content
GET
/
payments
List payments
curl --request GET \
  --url https://api.natural.co/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "payment",
      "id": "pay_550e8400e29b41d4a716446655440000",
      "attributes": {
        "amount": 500000,
        "currency": "USD",
        "status": "PROCESSING",
        "description": "Payment for Q4 2025 development work",
        "createdAt": "2026-01-04T15:30:00Z",
        "updatedAt": "2026-01-04T15:30:00Z"
      },
      "relationships": {
        "sender": {
          "data": {
            "type": "party",
            "id": "pty_019cd1798d617f65a79cb965dda9eac3"
          }
        },
        "recipient": {
          "data": {
            "type": "party",
            "id": "pty_019cd1798d627ad9bc302511c4f2c115"
          }
        },
        "transaction": {
          "data": {
            "type": "transaction",
            "id": "txn_550e8400e29b41d4a716446655440000"
          }
        }
      }
    }
  ],
  "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

partyId
string

Party ID for delegated payment lookup

Pattern: ^pty_[0-9a-f]{32}$
limit
integer
default:50

Results per page

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

Pagination cursor from previous response

Response

Successful Response

data
PaymentResource · object[]
required
meta
object
required