list_payments
Retrieve and filter payment records from GoCardless by status, subscription, or mandate to monitor transaction history and track payment status.
Instructions
List payments from GoCardless
Input Schema
Name | Required | Description | Default |
---|---|---|---|
limit | No | Number of payments to retrieve (default: 50) | |
mandate | No | Filter by mandate ID (e.g., MD123) | |
status | No | Filter by payment status (pending_customer_approval, pending_submission, submitted, confirmed, paid_out, cancelled, customer_approval_denied, failed, charged_back) | |
subscription | No | Filter by subscription ID (e.g., SB123) |
Input Schema (JSON Schema)
{
"properties": {
"limit": {
"description": "Number of payments to retrieve (default: 50)",
"type": "integer"
},
"mandate": {
"description": "Filter by mandate ID (e.g., MD123)",
"type": "string"
},
"status": {
"description": "Filter by payment status (pending_customer_approval, pending_submission, submitted, confirmed, paid_out, cancelled, customer_approval_denied, failed, charged_back)",
"type": "string"
},
"subscription": {
"description": "Filter by subscription ID (e.g., SB123)",
"type": "string"
}
},
"type": "object"
}