Skip to content
FFastPay Docs

Payments

List payments

GET/api/v1/payments
AuthorizationBearer sk_test_… or sk_live_…

Query parameters#

  • limitintegerOptional

    From 1 to 200. Defaults to 50.

  • offsetintegerOptional

    At least 0. Defaults to 0.

  • statusstringOptional

    succeeded, pending (includes processing), failed (includes cancelled) or abandoned (timed out). One of succeeded, pending, failed, abandoned.

  • methodstringOptional

    Up to 40 characters.

  • searchstringOptional

    Matches part of a reference, the description, or the customer's email or name; a whole payment id matches that payment. Up to 120 characters.

  • sincetimestampOptional
  • untiltimestampOptional

Responses#

  • 200Payments, most recent first
  • 401The secret key is missing, invalid or revoked.
  • 403The key is not allowed to do this, or the request came from an address that is not on its allowlist.
  • 404Nothing was found for this business and mode.