Payment Card Runs
A payment card run handles a batch of card payments on a chosen date. The API lets you retrieve runs and their results. Most businesses let automatic collection create and process runs; see Payment Runs.
Methods
Section titled “Methods”Retrieve Single Payment Card Run
Section titled “Retrieve Single Payment Card Run”/backend/api/v1/paymentCardRuns/ID - fetch the run with the specified ID.
List Payment Card Runs
Section titled “List Payment Card Runs”/backend/api/v1/paymentCardRuns/ - list all payment card runs.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include runs with a higher ID |
createdSince | datetime | No | Only include runs created since the given time |
updatedSince | datetime | No | Only include runs updated since the given time |
Runs are created and processed by the payment-run workflow and automatic collection, not through the API, so the endpoint is read-only.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| ourReference | Our Reference | Text | Unique reference identifier for this payment card run |
| status | Status | Preset Value | Current processing status of the payment card run |
| commencedDate | Commenced Date | Date | Date when this payment card run was commenced |
| completedDate | Completed Date | Date | Date when this payment card run was completed |
| collectedAmount | Collected Amount | Currency | Total amount successfully collected in this payment card run |
| paymentDate | Payment Date | Date | The date when payments will be credited to invoices |
| collectionDate | Collection Date | Date | The date when funds will be collected from the payment provider (if different than the payment date) |
| invoiceDate | Invoice Date | Date | Minimum invoice date for including invoices in this payment card run |
| id | Payment Card Run ID | Text | The unique identifier for this payment card run |