List payments
curl --request GET \
--url https://demo-api-harmony.compago.com/api/developer/v1/payment \
--header 'x-api-key: <api-key>'import requests
url = "https://demo-api-harmony.compago.com/api/developer/v1/payment"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://demo-api-harmony.compago.com/api/developer/v1/payment', 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://demo-api-harmony.compago.com/api/developer/v1/payment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://demo-api-harmony.compago.com/api/developer/v1/payment"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://demo-api-harmony.compago.com/api/developer/v1/payment")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo-api-harmony.compago.com/api/developer/v1/payment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "CONFIRMED",
"amount": 123,
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"operationCode": 123,
"type": "<string>",
"fee": 123,
"terms": 123,
"paidTerms": 123,
"periodicity": "<string>",
"financingMethod": "<string>",
"source": "<string>",
"refundedAt": "2023-11-07T05:31:56Z",
"heldAmount": 123,
"heldAt": "2023-11-07T05:31:56Z",
"capturedAt": "2023-11-07T05:31:56Z",
"holdReleasedAt": "2023-11-07T05:31:56Z",
"holdExpiresAt": "2023-11-07T05:31:56Z",
"holdExpired": true,
"holdDaysRemaining": 123,
"card": {
"lastFourDigits": "<string>",
"network": "<string>",
"fundingSource": "<string>",
"issuingBank": "<string>"
},
"customer": {
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phoneNumber": "<string>"
},
"paymentLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentIntentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"oneTimePaymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentMethodId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"pagination": {
"limit": 123,
"hasMore": true,
"nextCursor": "<string>"
}
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}Payments
List payments
Every payment your organization has taken, newest first. Scoped to your own businesses: payments merely funded by one of your promotions are not included.
GET
/
developer
/
v1
/
payment
List payments
curl --request GET \
--url https://demo-api-harmony.compago.com/api/developer/v1/payment \
--header 'x-api-key: <api-key>'import requests
url = "https://demo-api-harmony.compago.com/api/developer/v1/payment"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://demo-api-harmony.compago.com/api/developer/v1/payment', 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://demo-api-harmony.compago.com/api/developer/v1/payment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://demo-api-harmony.compago.com/api/developer/v1/payment"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://demo-api-harmony.compago.com/api/developer/v1/payment")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo-api-harmony.compago.com/api/developer/v1/payment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "CONFIRMED",
"amount": 123,
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"operationCode": 123,
"type": "<string>",
"fee": 123,
"terms": 123,
"paidTerms": 123,
"periodicity": "<string>",
"financingMethod": "<string>",
"source": "<string>",
"refundedAt": "2023-11-07T05:31:56Z",
"heldAmount": 123,
"heldAt": "2023-11-07T05:31:56Z",
"capturedAt": "2023-11-07T05:31:56Z",
"holdReleasedAt": "2023-11-07T05:31:56Z",
"holdExpiresAt": "2023-11-07T05:31:56Z",
"holdExpired": true,
"holdDaysRemaining": 123,
"card": {
"lastFourDigits": "<string>",
"network": "<string>",
"fundingSource": "<string>",
"issuingBank": "<string>"
},
"customer": {
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phoneNumber": "<string>"
},
"paymentLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentIntentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"oneTimePaymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentMethodId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"pagination": {
"limit": 123,
"hasMore": true,
"nextCursor": "<string>"
}
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}Authorizations
Query Parameters
Rows per page. Values above 100 are rejected.
Required range:
1 <= x <= 100Opaque cursor from a previous response's pagination.nextCursor. Omit for the first page.
Filter by status. Repeat for several.
Available options:
CONFIRMED, CANCELLED, REFUNDED, HELD, HOLD_RELEASED, HOLD_EXPIRED Filter by capture type.
Available options:
CARD_PRESENT, CARD_NOT_PRESENT Exact operation code.
Only payments taken through this link.
Only payments billed by this subscription.
Only payments for this one-time payment.
Only payments charged to this saved card.
Inclusive lower bound.
Inclusive upper bound.