List payouts
curl --request GET \
--url https://api.cope.com/v1/commerce/payouts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cope.com/v1/commerce/payouts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cope.com/v1/commerce/payouts', 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://api.cope.com/v1/commerce/payouts",
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://api.cope.com/v1/commerce/payouts"
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))
}HttpResponse<String> response = Unirest.get("https://api.cope.com/v1/commerce/payouts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cope.com/v1/commerce/payouts")
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{
"data": [
{
"amount_minor_units": 123,
"arrival_date": "2023-12-25",
"arrival_estimated": true,
"currency": "<string>",
"fee_minor_units": 123,
"id": "po_A1b2C3d4E5f6G7h8",
"initiated_at": "2023-11-07T05:31:56Z",
"object": "payout",
"payout_date": "2023-12-25",
"settled_at": "2023-11-07T05:31:56Z",
"status": "processing",
"transaction_count": 123,
"transfer_amount_minor_units": 123,
"transferred_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"current_page": 123,
"per_page": 123,
"total_count": 123,
"total_pages": 123
}
}
List payouts
Lists the business’s payouts, newest first by initiated_at. A payout is one transfer of your available balance in one currency to your bank account. Its figures are the ones the Finance page of the dashboard shows. This resource follows the API convention: {object, id} references, *_minor_units amounts, millisecond UTC timestamps.
Requires the payouts permission at read. An API key holds a permission at the lower of its own level (read for a read-only key) and its holder’s role; a key without it is refused with 403.
GET
/
v1
/
commerce
/
payouts
List payouts
curl --request GET \
--url https://api.cope.com/v1/commerce/payouts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cope.com/v1/commerce/payouts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cope.com/v1/commerce/payouts', 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://api.cope.com/v1/commerce/payouts",
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://api.cope.com/v1/commerce/payouts"
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))
}HttpResponse<String> response = Unirest.get("https://api.cope.com/v1/commerce/payouts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cope.com/v1/commerce/payouts")
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{
"data": [
{
"amount_minor_units": 123,
"arrival_date": "2023-12-25",
"arrival_estimated": true,
"currency": "<string>",
"fee_minor_units": 123,
"id": "po_A1b2C3d4E5f6G7h8",
"initiated_at": "2023-11-07T05:31:56Z",
"object": "payout",
"payout_date": "2023-12-25",
"settled_at": "2023-11-07T05:31:56Z",
"status": "processing",
"transaction_count": 123,
"transfer_amount_minor_units": 123,
"transferred_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"current_page": 123,
"per_page": 123,
"total_count": 123,
"total_pages": 123
}
}