NAnatural
Payment Intents

List payment intents

Changed on

List payment intents, newest first

get/payment-intents

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/payment-intents
  • Auth
    HTTP bearer

Query parameters

customerPartyIdstring

Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer.

status'open' | 'processing' | 'completed' | 'canceled' | 'declined' | 'expired'

Only intents with this status.

createdAfterstring

Only intents created after this RFC 3339 timestamp (exclusive).

createdBeforestring

Only intents created before this RFC 3339 timestamp (exclusive).

limitinteger

Maximum results per page.

cursorstring

Cursor from the previous page.

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes

  • 59c1208fa5dcRevision changes
    • info

      added the optional property /// to the response with the status

  • 46c3e5516668Revision changes
    • warning

      added the new authorized enum value to the /// response property for the response status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status