NAnatural
Check

List check payments

Changed on

List your check payments

get/check

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/check
  • 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'CREATED' | 'AWAITING_APPROVAL' | 'APPROVAL_DENIED' | 'PROCESSING' | 'COMPLETED' | 'RETURNED' | 'CANCELING' | 'CANCELED' | 'EXPIRED' | 'REJECTED' | 'FAILED'

Filter by status.

externalPartyIdstring

Only checks to this external party (epty_*).

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