Transactions

List transactions

Changed on

List transactions

get/transactions

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/transactions
  • Auth
    HTTP bearer

Query parameters

type'payment' | 'transfer' | 'refund' | 'chargeback' | 'all'

Filter by transaction type. Chargeback rows need chargebacks.read. Without it, all leaves them out and chargeback returns an empty page.

limitinteger

Maximum results per page.

cursorstring

Cursor from the previous page.

counterpartyPartyIdstring

Restrict results to transactions whose payment counterparty is this party.

walletIdstring

Restrict results to transactions visible through this wallet.

customerPartyIdstring

Restrict results to delegated activity performed for this customer, not activity involving it as a payment counterparty.

delegatedboolean

When true, return only transactions an agent performed for a connected customer.

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

    • info

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

    • warning

      added the new chargeback enum value to the /// response property for the response status

    • info

      added the new enum value chargeback to the query request parameter type

    • info

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