NAnatural
Card Payments

List card payments

Changed on

List card payment attempts, newest first. Filter by paymentIntentId to see attempts for one intent.

get/card-payments

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/card-payments
  • Auth
    HTTP bearer

Query parameters

customerPartyIdstring

Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer.

paymentIntentIdstring

Only attempts for this payment intent (pmi_*).

subscriptionIdstring

Early access (subscriptions). Only attempts whose subscription is this subscription (sub_*): each attempt at each of its payments, payment 1's checkout attempts included.

status'processing' | 'succeeded' | 'failed'

Only attempts with this status.

createdAfterstring

Only attempts created after this RFC 3339 timestamp (exclusive).

createdBeforestring

Only attempts created before this RFC 3339 timestamp (exclusive).

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

  • 46c3e5516668Revision changes
    • warning

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

    • warning

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

    • warning

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

    • info

      added the new optional query request parameter subscriptionId

    • info

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

  • 84d3e68026cfRevision changes
    • info

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