Get A Paginated List Of Payments

🚧

Paginated Response

Objects are returned in pages of 100 items. Pass the page=X query parameter, where X is the page number, to retrieve each page of the request result. Using page=1 will retrieve the first page of the result.

Example Response

See Get Payment Detail for more details.

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "810499e6-11d8-474a-9768-4118ba3b25b8",
            "amount_cents": 175,
            "currency": "USD",
            "originating_counterparty_id": "00d26d58-f902-42df-bbc3-e9dc071c8a8c",
            "receiving_counterparty_id": "03aac7c4-fa5a-45a3-a028-16c3fef48106",
            "payment_method": "check",
            "reissue_payment_method": "ach",
            "delivery_method": "mail",
            "reconciliation_id": null,
            "tracking_id": "RC00F00D00F21N41A",
            "instrument_number": null,
            "status": "settled",
            "events": [
                {
                    "timestamp": "2024-08-07T17:05:42.513000",
                    "event_code": "PU00",
                    "description": "Invoices Created",
                    "amount_cents": 175,
                    "stage": "processing",
                    "method": null,
                    "event_name": "requested",
                    "status": "in-progress"
                },
                {
                    "timestamp": "2024-08-07T17:06:01.723000",
                    "event_code": "PU12",
                    "description": "Payments Received By Processor",
                    "amount_cents": 175,
                    "stage": "processing",
                    "method": null,
                    "event_name": "confirmed",
                    "status": "in-progress"
                },
                {
                    "timestamp": "2024-08-07T17:06:13.316000",
                    "event_code": "FA00",
                    "description": "Request ACH Funding",
                    "amount_cents": 175,
                    "stage": "funding",
                    "method": "ach",
                    "event_name": "requested",
                    "status": "in-progress"
                },
                {
                    "timestamp": "2024-08-07T17:06:13.748000",
                    "event_code": "FA10",
                    "description": "ACH Funding Received",
                    "amount_cents": 175,
                    "stage": "funding",
                    "method": "ach",
                    "event_name": "received",
                    "status": "in-progress"
                },
                {
                    "timestamp": "2024-08-07T17:09:26.615000",
                    "event_code": "DC13",
                    "description": "Check Printed",
                    "amount_cents": 175,
                    "stage": "disbursement",
                    "method": "check",
                    "event_name": "printed",
                    "status": "in-progress"
                },
                {
                    "timestamp": "2024-08-12T18:09:25.143000",
                    "event_code": "IO36",
                    "description": "Reissue Initiated by Operations",
                    "amount_cents": 175,
                    "stage": "reissue",
                    "method": "operations",
                    "event_name": "initiated",
                    "status": "in-progress"
                },
                {
                    "timestamp": "2024-08-12T18:09:36.498000",
                    "event_code": "IC21",
                    "description": "Check Stop Requested",
                    "amount_cents": 175,
                    "stage": "reissue",
                    "method": "check",
                    "event_name": "stop_requested",
                    "status": "in-progress"
                },
                {
                    "timestamp": "2024-08-12T18:09:37.037000",
                    "event_code": "IC23",
                    "description": "Check Stop Confirmed",
                    "amount_cents": 175,
                    "stage": "reissue",
                    "method": "check",
                    "event_name": "stop_confirmed",
                    "status": "in-progress"
                },
                {
                    "timestamp": "2024-08-12T19:21:34.769000",
                    "event_code": "IA20",
                    "description": "Reissue ACH Sent",
                    "amount_cents": 175,
                    "stage": "reissue",
                    "method": "ach",
                    "event_name": "sent",
                    "status": "in-progress"
                }
            ],
            "invoices": [
                {
                    "id": "2a815574-939e-41a3-9af8-e1bfb220985e",
                    "invoice_number": "202408071305",
                    "payment_amount_cents": 175,
                    "metadata": {
                        "id": "3",
                        "user": "ryan"
                    },
                    "public_account_number": null,
                    "reconciliation_id": null,
                    "payment_group_id": ""
                }
            ],
            "adjustments": [],
            "created": "2024-08-07T17:05:42.403000",
            "updated": "2024-08-12T19:21:40.896000",
            "funding_drawdown_request_id": "DJ00000008C0",
            "refund_user": null,
            "refund_timestamp": null,
            "refund_reason": null,
            "refund_comment": null,
            "refund_ticket_number": null,
            "reissue_user": "[email protected]",
            "reissue_timestamp": "2024-08-12T18:09:25.014000",
            "reissue_reason": "Customer has requested a different payment method.",
            "reissue_comment": null,
            "reissue_ticket_number": null
        },
        {
            "id": "be5f7fab-285c-42fe-b3a3-12b550e53d5c",
            "amount_cents": 333,
            "currency": "USD",
            "originating_counterparty_id": "041bbd12-7ee0-4e33-b8bc-1bd7736a58c3",
            "receiving_counterparty_id": "68732352-1b68-4072-9ca1-d3379e829f59",
            "payment_method": "wire",
            "reissue_payment_method": null,
            "delivery_method": "email",
            "reconciliation_id": null,
            "tracking_id": "RC00R00X00I21A40B",
            "instrument_number": null,
            "status": "in-progress",
            "events": [
                {
                    "timestamp": "2024-08-07T13:44:53.590000",
                    "event_code": "PU00",
                    "description": "Invoices Created",
                    "amount_cents": 333,
                    "stage": "processing",
                    "method": null,
                    "event_name": "requested",
                    "status": "in-progress"
                },
                {
                    "timestamp": "2024-08-07T13:44:55.055000",
                    "event_code": "PU12",
                    "description": "Payments Received By Processor",
                    "amount_cents": 333,
                    "stage": "processing",
                    "method": null,
                    "event_name": "confirmed",
                    "status": "in-progress"
                },
                {
                    "timestamp": "2024-08-07T13:44:55.773000",
                    "event_code": "FA00",
                    "description": "Request ACH Funding",
                    "amount_cents": 333,
                    "stage": "funding",
                    "method": "ach",
                    "event_name": "requested",
                    "status": "in-progress"
                }
            ],
            "invoices": [
                {
                    "id": "b3e77c89-aedc-4aa0-848f-1b4014b27087",
                    "invoice_number": "202402ss1426",
                    "payment_amount_cents": 333,
                    "metadata": {
                        "someMetadata": "value"
                    },
                    "public_account_number": null,
                    "reconciliation_id": null,
                    "payment_group_id": ""
                }
            ],
            "adjustments": [],
            "created": "2024-08-07T13:44:53.575000",
            "updated": "2024-08-07T13:44:55.903000",
            "funding_drawdown_request_id": "U824-012-419K",
            "refund_user": null,
            "refund_timestamp": null,
            "refund_reason": null,
            "refund_comment": null,
            "refund_ticket_number": null,
            "reissue_user": null,
            "reissue_timestamp": null,
            "reissue_reason": null,
            "reissue_comment": null,
            "reissue_ticket_number": null
        }
    ]
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!