payments_list
Lists completed payments using the ifthenpay Backoffice Key. Filter by payment method, date range, order ID, reference or request ID. Returns up to 1000 most recent payments if no filters are applied.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | No | Filter by exact payment amount. | |
| bo_key | Yes | ifthenpay Backoffice Key (provided when signing the contract). | |
| entity | No | Payment method entity filter. Use: MB, MBWAY, PAYSHOP, CCARD, COFIDIS, GOOGLE, APPLE, PIX, or a 5-digit Multibanco entity number. Leave blank for all methods. | |
| date_end | No | End date/time in format dd-MM-yyyy HH:mm:ss (e.g. 31-01-2024 23:59:59). | |
| order_id | No | Filter by order identifier. | |
| reference | No | Filter by payment reference (Multibanco/Payshop reference or orderId for other methods). | |
| date_start | No | Start date/time in format dd-MM-yyyy HH:mm:ss (e.g. 01-01-2024 00:00:00). | |
| request_id | No | Filter by the unique request token returned at payment creation. | |
| sub_entity | No | Payment method key or sub-entity (e.g. MB KEY, MBWAY KEY, PAYSHOP KEY). Leave blank to match all. |