VEvetcove
Payments

Fetch a payment

Retrieves a payment by its ID.

A payment represents a payment made by a clinic client (pet parent). Payments can be made via credit card, cash, check, client credit, or other external payment methods. Each payment records the amount, type, and current status of the transaction. Payments are never deleted.

get/ext/v2/payments/{payment_id}/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/payments/{payment_id}/
  • Auth
    HTTP bearer

Path parameters

payment_idinteger required

The ID of the payment to fetch

Response

OK

amountinteger required

The payment amount in cents.

clinic_client_idinteger required

The ID of the clinic client who made this payment.

clinic_idinteger required

The ID of the clinic associated with this payment.

createdstring date-time required

The datetime this object was created.

currency'USD' | 'CAD' required
idinteger required

The unique identifier for the payment.

modifiedstring date-time required

The datetime this object was last modified; changes to related entities will not update this field.

payment_link_idinteger nullable required

The ID of the payment link used for this payment, if any.

payment_type'CARD_SAVED' | 'CARD_READER' | 'CLIENT_CREDIT' | 'CASH' | 'CHECK' | 'CUSTOM' required
recorded_atstring date-time required

When this payment was officially recorded.

status'PENDING' | 'COMPLETED' | 'CANCELED' | 'FAILED' | 'VOIDED' required
void_reasonstring required

The reason this payment was voided, if applicable.

voided_atstring date-time nullable required

When this payment was voided, if applicable.

Changes

No recorded changes to this operation across all 1 revision of this API.