curl --request GET \
--url https://demo-api-honor.compago.com/api/developer/payment \
--header 'x-api-key: <api-key>'import requests
url = "https://demo-api-honor.compago.com/api/developer/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-honor.compago.com/api/developer/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-honor.compago.com/api/developer/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-honor.compago.com/api/developer/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-honor.compago.com/api/developer/payment")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo-api-honor.compago.com/api/developer/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": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"status": "PENDING",
"type": "CARD_NOT_PRESENT",
"financingMethod": "INSTALLMENTS",
"operationCode": 10000000001,
"amount": 1500,
"currency": "MXN",
"terms": 6,
"periodicity": "MONTHLY",
"createdAt": "2023-11-07T05:31:56Z",
"organization": {
"id": "11111111-2222-3333-4444-555555555555",
"name": "Acme Store"
},
"cardInformation": {
"lastFourDigits": "**89",
"networkType": "VISA",
"issuingBank": "Bank of Example",
"fundingSource": "CREDIT",
"entryMode": "CHIP"
},
"paymentDisbursement": {
"feePercentage": 3.5,
"promotionFeeDiscount": 0,
"finalFeePercentageForMerchant": 3.5,
"finalFeePercentageForManufacturer": 0,
"promotionBusinessTake": 0,
"feeAmount": "52.50",
"merchantFeeAmount": "52.50",
"manufacturerFeeAmount": "0.00",
"merchantIvaFeeAmount": "8.40",
"manufacturerIvaFeeAmount": "0.00",
"totalFeeIva": "8.40",
"promotionTakeAmount": "0.00",
"merchantTakeAmount": "1439.10",
"manufacturerTakeAmount": "0.00"
},
"transaction": {
"bankReference": "123456789012",
"rawResponseText": "Approved",
"authResult": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"authCode": "123456",
"resultCode": "00"
},
"terminal": {
"serialNumber": "TERM-00000001"
},
"billingInformation": {
"email": "customer@example.com",
"firstName": "Jane",
"lastName": "Doe",
"phoneNumber": "+5215555555555",
"address": {
"addressLine": "Calle Example 123",
"city": "Ciudad de Mexico",
"state": "CDMX",
"zip": "01000"
}
},
"salesperson": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Maria Garcia",
"username": "maria.garcia"
},
"businessStoreBranch": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Polanco Branch"
}
}
],
"pagination": {
"limit": 20,
"offset": 0,
"count": 10
}
}List Payments
Retrieve a paginated list of payments across all organizations managed by your sales partner account. Supports filtering by status, type, financing method, terms, issuing bank, organization, date range, and free text search.
curl --request GET \
--url https://demo-api-honor.compago.com/api/developer/payment \
--header 'x-api-key: <api-key>'import requests
url = "https://demo-api-honor.compago.com/api/developer/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-honor.compago.com/api/developer/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-honor.compago.com/api/developer/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-honor.compago.com/api/developer/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-honor.compago.com/api/developer/payment")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo-api-honor.compago.com/api/developer/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": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"status": "PENDING",
"type": "CARD_NOT_PRESENT",
"financingMethod": "INSTALLMENTS",
"operationCode": 10000000001,
"amount": 1500,
"currency": "MXN",
"terms": 6,
"periodicity": "MONTHLY",
"createdAt": "2023-11-07T05:31:56Z",
"organization": {
"id": "11111111-2222-3333-4444-555555555555",
"name": "Acme Store"
},
"cardInformation": {
"lastFourDigits": "**89",
"networkType": "VISA",
"issuingBank": "Bank of Example",
"fundingSource": "CREDIT",
"entryMode": "CHIP"
},
"paymentDisbursement": {
"feePercentage": 3.5,
"promotionFeeDiscount": 0,
"finalFeePercentageForMerchant": 3.5,
"finalFeePercentageForManufacturer": 0,
"promotionBusinessTake": 0,
"feeAmount": "52.50",
"merchantFeeAmount": "52.50",
"manufacturerFeeAmount": "0.00",
"merchantIvaFeeAmount": "8.40",
"manufacturerIvaFeeAmount": "0.00",
"totalFeeIva": "8.40",
"promotionTakeAmount": "0.00",
"merchantTakeAmount": "1439.10",
"manufacturerTakeAmount": "0.00"
},
"transaction": {
"bankReference": "123456789012",
"rawResponseText": "Approved",
"authResult": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"authCode": "123456",
"resultCode": "00"
},
"terminal": {
"serialNumber": "TERM-00000001"
},
"billingInformation": {
"email": "customer@example.com",
"firstName": "Jane",
"lastName": "Doe",
"phoneNumber": "+5215555555555",
"address": {
"addressLine": "Calle Example 123",
"city": "Ciudad de Mexico",
"state": "CDMX",
"zip": "01000"
}
},
"salesperson": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Maria Garcia",
"username": "maria.garcia"
},
"businessStoreBranch": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Polanco Branch"
}
}
],
"pagination": {
"limit": 20,
"offset": 0,
"count": 10
}
}Authorizations
Query Parameters
Filter by a specific payment ID
Filter by payment status. Supports multiple values by repeating the parameter (e.g. ?status=PENDING&status=CONFIRMED).
PENDING, CANCELLED, CONFIRMED, REFUNDED Filter by payment type. Supports multiple values.
CARD_NOT_PRESENT, CARD_PRESENT Filter by financing method. Supports multiple values.
INSTALLMENTS, PAY_NOW Filter by number of installment terms (e.g. 3, 6, 12). Supports multiple values.
x >= 1Filter by the card's issuing bank name. Supports multiple values.
Filter by organization ID. Only organizations under your sales partner account are accessible. Supports multiple values.
Filter payments created on or after this date (inclusive). Uses Mexico City timezone (CST/CDT).
Filter payments created on or before this date (inclusive). Uses Mexico City timezone (CST/CDT).
Search by operation code (partial match)
Free text search. Matches against payment amount and organization name.
Number of results per page (default: 20, max: 100)
1 <= x <= 100Number of results to skip for pagination (default: 0)
x >= 0