NAnatural
PaymentRequests

List incoming payment requests

Changed on

List incoming payment requests

get/payment-requests/incoming

Request

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

Query parameters

limitinteger

Maximum results per page.

cursorstring

Cursor from the previous page.

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.

addressedToAgentstring

Only payment requests addressed to this agent (agt_*) as payer.

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

  • b1bbe421e39fRevision changes
    • info

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

  • 897916372a74Revision changes
    • breaking

      removed the required property /// from the response with the status

    • info

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