Retrieve payin settlements
curl --request GET \
--url https://api.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements', 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.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements",
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.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements"
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.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements")
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{
"items": [
{
"id": "01HPR57X6QR5ZRKEEKBSDBW4RA",
"merchantAccountId": "01HPR8S7YF43PV3QV16TZDC80P",
"totalAmountCollected": 100000,
"totalFees": 500,
"numberOfPayins": 5,
"payinSettlementDate": "2024-08-28",
"payinSettlementCycle": 11,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"cursor": "fa4c20cf2b51f6a45377c98271e3754da1e29b6827928a8e0b40da5a7d53c971aa22c50b2c8ce83484a0dd36ee0e2570a0520a4f1f4817962d95ba65059b9a28da1a5d4ac7bfe7628fb917efd20608656da58b412ea758ec341cd6dfb226f8be263cefa811848b859a5a71f90f47533e01e969d49c0ac9e4e944b3d0fbd4e207",
"count": 123
}{
"message": "<string>"
}{
"message": "<string>"
}Payin Settlements
List all payin settlements
GET
/
merchantAccounts
/
{merchantAccountId}
/
settlements
Retrieve payin settlements
curl --request GET \
--url https://api.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements', 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.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements",
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.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements"
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.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.palomma.com/v0/merchantAccounts/{merchantAccountId}/settlements")
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{
"items": [
{
"id": "01HPR57X6QR5ZRKEEKBSDBW4RA",
"merchantAccountId": "01HPR8S7YF43PV3QV16TZDC80P",
"totalAmountCollected": 100000,
"totalFees": 500,
"numberOfPayins": 5,
"payinSettlementDate": "2024-08-28",
"payinSettlementCycle": 11,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"cursor": "fa4c20cf2b51f6a45377c98271e3754da1e29b6827928a8e0b40da5a7d53c971aa22c50b2c8ce83484a0dd36ee0e2570a0520a4f1f4817962d95ba65059b9a28da1a5d4ac7bfe7628fb917efd20608656da58b412ea758ec341cd6dfb226f8be263cefa811848b859a5a71f90f47533e01e969d49c0ac9e4e944b3d0fbd4e207",
"count": 123
}{
"message": "<string>"
}{
"message": "<string>"
}This endpoint is paginated to improve its performance. The example below shows
how to fetch multiple pages.
import axios from "axios";
const getPage = async (input: { limit?: number; cursor?: string }) => {
const response = await axios.get("https://api.palomma.com/v0/customers", {
headers: {
Authorization: "Bearer <token>",
},
params: {
...input,
},
});
if (!response.data) throw new Error();
const { items, cursor, count } = response.data;
return { items, cursor, count };
};
const getAll = async (input: { limit?: number }) => {
let items: any[] = [];
const firstPage = await getPage({ limit: input.limit });
if (firstPage) {
items = items.concat(firstPage.items);
let currentCursor = firstPage.cursor;
while (currentCursor !== null) {
const nextPage = await getPage({
limit: input.limit,
cursor: currentCursor,
});
items = items.concat(nextPage.items);
currentCursor = nextPage.cursor;
}
}
return items;
};
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the merchant account.
Query Parameters
Number of records to return. Default is 20. Maximum is 100.
A cursor for use in pagination. The cursor indicates where to start fetching the results.
Response
List of payin settlements successfully retrieved.
Show child attributes
Show child attributes
A cursor for use in pagination. Provide this value in the cursor parameter to retrieve the next set of results. When there are no more results, the cursor will be null.
Example:
"fa4c20cf2b51f6a45377c98271e3754da1e29b6827928a8e0b40da5a7d53c971aa22c50b2c8ce83484a0dd36ee0e2570a0520a4f1f4817962d95ba65059b9a28da1a5d4ac7bfe7628fb917efd20608656da58b412ea758ec341cd6dfb226f8be263cefa811848b859a5a71f90f47533e01e969d49c0ac9e4e944b3d0fbd4e207"
The total number of items returned.