NAnatural
Realtime

List realtime payments

Changed on

List your realtime payments

get/realtime

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/realtime
  • 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' | 'SETTLED' | 'FAILED' | 'CANCELED'

Filter by status.

externalPartyIdstring

Only payments to this external party (epty_*).

externalPartyAccountIdstring

Only payments using this account (epa_*).

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

  • 897916372a74Revision changes
    • info

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

  • e79d669f0234Revision changes
    • info

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