v1
latestOpenAPI 3.0.02026-07-26280204.9 KBPayout Sender
Get All Payout Senders
Retrieve a list of all payout senders. You can filter the list with query parameters.
This API comes with Pagination support, you can customize limit and page query parameters as per the requirements.
get/payout-sender
Query parameters
pageinteger
Example:1
Page number (default- 1)
limitinteger
Example:10
Records per page (default- 10)
payout_sender_idstring
Example:ps_abc123def456
Filter by sender ID
type'company' | 'individual'
Example:individual
Filter by type (individual or company)
sender_namestring
Example:John Doe
Filter by sender name
emailstring
Example:john@example.com
Filter by email
organization_reference_idstring
Example:org_ref_123
Filter by organization reference ID
address_line1string
Example:123 Main Street
Filter by address line 1
address_line2string
Example:Suite 100
Filter by address line 2
address_citystring
Example:San Francisco
Filter by city
address_statestring
Example:CA
Filter by state
address_countrystring
Example:US
Filter by country
address_zip_codestring
Example:94105
Filter by zip code
phone_numberstring
Example:1234567890
Filter by phone number
phone_country_codestring
Example:+1
Filter by phone country code
phone_number_e164string
Example:+11234567890
Filter by E.164 phone number
descriptionstring
Example:Primary sender
Filter by description
is_activeboolean
Example:true
Filter by active status
created_atstring date
Example:2025-01-27
Filter by creation date (Format YYYY-MM-DD)
Response
OK