NAnatural
Card Sessions

List card sessions

Changed on

List the card sessions you opened for the party you act for, newest first. It never includes card data.

get/card-sessions

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/card-sessions
  • Auth
    HTTP bearer

Query parameters

customerPartyIdstring

Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

status'pending_approval' | 'approved' | 'declined' | 'claimed' | 'expired'

Only sessions with this status.

referencestring

Only sessions created with this reference.

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