How to Export Scheduled Payments for a Customer

This guide shows you how to retrieve and export scheduled payments for a specific customer using the Straddle API.

Overview

Use the Payments Search API to filter and export scheduled payments. This endpoint supports filtering by customer ID, payment status, and other criteria to help you generate reports on upcoming payments.

API Endpoint


GET https://sandbox.straddle.com/v1/payments

Basic Request

To get all scheduled payments for a customer:


GET https://sandbox.straddle.com/v1/payments?customer_id={customer_id}&payment_status=scheduled

Replace {customer_id} with the actual customer ID.

Query Parameters

Parameter	Description
`customer_id`	Filter by specific customer ID
`payment_status`	Use `scheduled` to get only scheduled payments
`payment_type`	Filter by `charge` or `payout`
`min_payment_date`	Filter payments scheduled on or after this date
`max_payment_date`	Filter payments scheduled on or before this date
`page_size`	Number of results per page (max 1,000)
`sort_by`	Sort by `payment_date`, `created_at`, or `amount`

Response

The API returns payment details including:

Amount
Status
Customer information
Scheduled payment date
Payment metadata