Fetch a payment - Vetcove docs

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

GET

/

ext

/

v2

/

payments

/

{payment_id}

/

Fetch a payment

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/payments/{payment_id}/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/payments/{payment_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/payments/{payment_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/payments/{payment_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/payments/{payment_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "amount": 123,
  "clinic_client_id": 123,
  "clinic_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "currency": "USD",
  "id": 123,
  "modified": "2023-11-07T05:31:56Z",
  "payment_link_id": 123,
  "payment_type": "CARD_SAVED",
  "recorded_at": "2023-11-07T05:31:56Z",
  "status": "PENDING",
  "void_reason": "<string>",
  "voided_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payment_id

integer

required

The ID of the payment to fetch

Response

200 - application/json

OK

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.

amount

integer

required

The payment amount in cents.

clinic_client_id

integer

required

The ID of the clinic client who made this payment.

clinic_id

integer

required

The ID of the clinic associated with this payment.

created

string<date-time>

required

The datetime this object was created.

currency

enum<string>

required

The currency of this payment.

Available options:

USD,

CAD

id

integer

required

The unique identifier for the payment.

modified

string<date-time>

required

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

payment_link_id

integer | null

required

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

payment_type

enum<string>

required

The method used to make this payment.

Available options:

CARD_SAVED,

CARD_READER,

CLIENT_CREDIT,

CASH,

CHECK,

CUSTOM

recorded_at

string<date-time>

required

When this payment was officially recorded.

status

enum<string>

required

The current status of this payment.

Available options:

PENDING,

COMPLETED,

CANCELED,

FAILED,

VOIDED

void_reason

string

required

The reason this payment was voided, if applicable.

voided_at

string<date-time> | null

required

When this payment was voided, if applicable.

⌘I

Fetch a payment

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/payments/{payment_id}/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/payments/{payment_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/payments/{payment_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/payments/{payment_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/payments/{payment_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "amount": 123,
  "clinic_client_id": 123,
  "clinic_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "currency": "USD",
  "id": 123,
  "modified": "2023-11-07T05:31:56Z",
  "payment_link_id": 123,
  "payment_type": "CARD_SAVED",
  "recorded_at": "2023-11-07T05:31:56Z",
  "status": "PENDING",
  "void_reason": "<string>",
  "voided_at": "2023-11-07T05:31:56Z"
}