Payments

List payments

List sent payments

get/payments

Query parameters

partyIdstring

Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

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

Changed in 4 of the 28 revisions of this API.14

    • deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

    • header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

    • added the required property data/items/attributes/tags to the response with the 200 status

      response-required-property-added

  • 270e233e401c11See the full diff
    • for the query request parameter cursor, the maxLength was set to 1024

      request-parameter-max-length-set

    • added the required property data/items/relationships/senderAgent to the response with the 200 status

      response-required-property-added