plaid

List payments

Changed on

The /payment_initiation/payment/list endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional count and cursor parameters.

post/payment_initiation/payment/list

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/payment_initiation/payment/list
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secretstring

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

countinteger nullable

The maximum number of payments to return. If count is not specified, a maximum of 10 payments will be returned, beginning with the most recent payment before the cursor (if specified).

cursorstring date-time nullable

A string in RFC 3339 format (i.e. "2019-12-06T22:35:49Z"). Only payments created before the cursor will be returned.

consent_idstring nullable

The consent ID. If specified, only payments, executed using this consent, will be returned.

Response

OK

next_cursorstring date-time nullable required

The value that, when used as the optional cursor parameter to /payment_initiation/payment/list, will return the next unreturned payment as its first payment.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

    • warning

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

  • a1bbca018160Revision changes
    • warning

      added the new ASSETS_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new CRA_MONITORING_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new ENCOMPASS_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new ENRICH_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new PROFILE_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new STATEMENTS_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status

    • warning

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