Fetch a payout - 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

/

payouts

/

{payout_id}

/

Fetch a payout

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

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

fetch('https://connect.vetcove.com/ext/v2/payouts/{payout_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/payouts/{payout_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/payouts/{payout_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/payouts/{payout_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,
  "amount_display": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "id": 123,
  "modified": "2023-11-07T05:31:56Z",
  "status": "PAID",
  "stripe_account_id": 123,
  "stripe_arrival_date": "2023-11-07T05:31:56Z",
  "stripe_created": "2023-11-07T05:31:56Z",
  "stripe_id": "<string>",
  "stripe_trace_id": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

payout_id

integer

required

ID of the payout to retrieve

Response

200 - application/json

OK

Schema representing a payout for an organization (external view)

amount

integer

required

Payout amount in cents

amount_display

string

required

Human-readable payout amount (e.g., $100.00)

created

string<date-time>

required

The datetime this object was created.

currency

string

required

Currency code for the payout (e.g., USD, CAD)

id

integer

required

Unique ID of the payout

modified

string<date-time>

required

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

status

required

Current status of the payout

Available options:

PAID,

PENDING,

IN_TRANSIT,

CANCELED,

FAILED

stripe_account_id

integer

required

ID of the Stripe account receiving the payout

stripe_arrival_date

string<date-time>

required

Stripe's estimated/actual arrival date for the funds

stripe_created

string<date-time>

required

Timestamp when the payout was created in Stripe

stripe_id

string

required

Stripe ID for this payout

stripe_trace_id

string | null

required

Trace ID of the payout (useful for bank statement reconciliation)

⌘I

Fetch a payout

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

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

fetch('https://connect.vetcove.com/ext/v2/payouts/{payout_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/payouts/{payout_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/payouts/{payout_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/payouts/{payout_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,
  "amount_display": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "id": 123,
  "modified": "2023-11-07T05:31:56Z",
  "status": "PAID",
  "stripe_account_id": 123,
  "stripe_arrival_date": "2023-11-07T05:31:56Z",
  "stripe_created": "2023-11-07T05:31:56Z",
  "stripe_id": "<string>",
  "stripe_trace_id": "<string>"
}