Documentation
Test environmentLive environmentStatusContact us
  • Overview
    • Get started
    • Resource guides
      • For business users
      • For finance teams
      • For integration teams
    • Stripe onboarding
    • Live use cases
      • Usage overview
  • Start using the dashboard
    • Access
    • Payment services
    • Collaborators and access control
    • One-time payment links
      • Single link creation
      • Bulk link creation
      • Send payment links
      • Payment link page
      • Payment receipt email
    • Subscriptions
      • Set-up
      • View subscriptions
      • Manage subscriptions
    • Payments and refunds
      • Payment methods
      • Dashboard
      • Refunds
    • Payouts
    • Reports
    • Payment workflows with Plumber
      • Set-up
      • Testing
    • Payment forms
      • Set-up
      • Testing
      • Resources
  • Start an API integration
    • Get started
    • Endpoints
    • Integrating with your e-services
    • Errors
    • Idempotency
    • Pagination
    • Go-live checklist
  • API RESOURCES
    • Events
      • The event object
      • Types of events
    • Payments
      • Create a payment
      • Retrieve payments
      • Send email for payment
      • Cancel a payment
      • Refund a payment
      • Get all payments from payment service
  • WEBHOOKS
    • Introduction
    • Set-up
      • Events
      • Best practices
  • FAQ
    • Access
    • Costs
    • Timeline
    • API keys
    • API integration
    • Payments
    • Payment methods
    • Payouts and transaction fees
    • Refunds
    • Security and compliance
    • Downtime and maintenance
  • Policies
    • Privacy Policy
    • Terms of Use
Powered by GitBook
On this page

Was this helpful?

  1. API RESOURCES
  2. Payments

Get all payments from payment service

Returns a list of payments created within a payment service.

PreviousRefund a paymentNextIntroduction

Last updated 7 months ago

Was this helpful?

Returns


A dictionary with a data property that contains an array of up to 20 payments. Each entry in the array is a separate payment object. If no other payments are available, the resulting array is empty.

GET /v1/payment-services/:payment_service_id?limit=20


Payment Filtering

Agencies can specify a string that they want to filter the payments to have (only by Ref Id, Name, Email). For example, specifying search=abc@gmail.com will filter payments with email abc@gmail.com.

Pagination

Additionally, the end point uses for retrieval of data. Results are sorted in ascending order of transaction creation date.

cursor pagination