Payment Card Payments
A payment card payment records each attempt to charge a customer’s card, including the amount, outcome, authorisation code, and any decline reason. These records are created by collection runs, so the API exposes them read-only for monitoring and reconciliation.
Methods
Section titled “Methods”Retrieve Single Payment Card Payment
Section titled “Retrieve Single Payment Card Payment”/backend/api/v1/paymentCardPayments/ID - fetch the card payment with the specified ID.
List Payment Card Payments
Section titled “List Payment Card Payments”/backend/api/v1/paymentCardPayments/ - list all card payments.
/backend/api/v1/payments/ID/paymentCardPayments/ - list the card collection attempts for the payment with the specified ID.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include payments with a higher ID |
createdSince | datetime | No | Only include payments created since the given time |
updatedSince | datetime | No | Only include payments updated since the given time |
Actions
Section titled “Actions”Available Actions
Section titled “Available Actions”cancelCollection
Section titled “cancelCollection”Cancel a pending card collection attempt, so it is not submitted to the provider.
Only pending attempts can be cancelled. An attempt that has already been submitted returns error code 400506. The action requires Standard Expert Level or higher on the calling account.
Example:
curl -X POST https://example.com/backend/api/v1/paymentCardPayments/123?action=cancelCollection \ -H "Authorization: Bearer YOUR_API_TOKEN"Collecting a card payment is deliberately not available over the API. Use the platform’s own collection workflow, described in Payment Cards.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| ourReference | Our Reference | Text | Internal reference number for this payment card payment |
| customerReference | Customer's Reference | Text | Reference number provided by the customer for this payment card payment |
| paymentCardID | Payment Card | Text | The payment card used for this payment |
| paymentCardRun | Payment Card Run | Preset Value | The payment card run this payment is part of |
| paymentCardPaymentAmount | Amount | Currency | The amount to be collected via payment card |
| status | Payment Status | Preset Value | Current status of the payment card payment |
| paymentCardPaymentSetupStamp | Requested Date | Date | Date when the payment card payment was requested |
| paymentCardPaymentTakenStamp | Taken Date | Date | Date when the payment card payment was successfully taken |
| providerStatus | Provider Status | Text | Status code returned by the payment card provider |
| providerStatusDetail | Provider Status Detail | Text | Detailed status information from the payment card provider |
| providerTransaction | Provider Transaction ID | Text | Transaction ID assigned by the payment card provider |
| providerKey | Provider Key | Text | Provider key for payment card processing |
| providerAuthorisationCode | Provider Authorisation Code | Text | Authorization code from the payment card provider |
| providerBankAuthorisationCode | Provider Bank Authorisation Code | Text | Bank authorization code from the payment card provider |
| providerDeclineCode | Provider Decline Code | Text | Decline code if the payment was declined by the provider |
| id | Payment Card Payment ID | Text | The unique identifier for this payment card payment |