curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/settlements/service-provider \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/settlements/service-provider"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/settlements/service-provider', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/settlements/service-provider';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"message": "succeeded",
"code": "0",
"data": [
{
"_id": "67c24dd60621becf9a41813e",
"subMerchantId": "jpt-sim-md-1",
"spProductId": "255",
"facId": "JPT",
"totalSales": 47090,
"refunds": 0,
"chargebacks": 0,
"taxHolding": 0,
"netSales": 45706.67,
"feesIds": [
"<string>"
],
"createdAt": "2025-02-28T23:59:18.385Z",
"updatedAt": "2025-02-28T23:59:18.385Z",
"platformFee": 1312.01,
"spProductFee": 71.32,
"interchangeFee": 0,
"totalFees": 1383.33,
"netSpProduct": 71.32
}
],
"totals": {
"_id": null,
"count": 23,
"totalSales": 85318.68,
"totalRefunds": 0,
"netSales": 82725.1,
"totalChargebacks": 0,
"taxHolding": 0,
"feesIdsLength": 324,
"platform": 2445.85,
"spProduct": 147.73,
"interchange": 0,
"totalFees": 2593.58,
"netSpProduct": 147.73
},
"query": {
"options": {
"limit": 1000
}
}
}List Service Provider settlements
Returns settlement records at the Service Provider level, including settlement timing and amounts.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/settlements/service-provider \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/settlements/service-provider"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/settlements/service-provider', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/settlements/service-provider';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"message": "succeeded",
"code": "0",
"data": [
{
"_id": "67c24dd60621becf9a41813e",
"subMerchantId": "jpt-sim-md-1",
"spProductId": "255",
"facId": "JPT",
"totalSales": 47090,
"refunds": 0,
"chargebacks": 0,
"taxHolding": 0,
"netSales": 45706.67,
"feesIds": [
"<string>"
],
"createdAt": "2025-02-28T23:59:18.385Z",
"updatedAt": "2025-02-28T23:59:18.385Z",
"platformFee": 1312.01,
"spProductFee": 71.32,
"interchangeFee": 0,
"totalFees": 1383.33,
"netSpProduct": 71.32
}
],
"totals": {
"_id": null,
"count": 23,
"totalSales": 85318.68,
"totalRefunds": 0,
"netSales": 82725.1,
"totalChargebacks": 0,
"taxHolding": 0,
"feesIdsLength": 324,
"platform": 2445.85,
"spProduct": 147.73,
"interchange": 0,
"totalFees": 2593.58,
"netSpProduct": 147.73
},
"query": {
"options": {
"limit": 1000
}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
The body is of type object.
Response
findSettlementsServiceProvider
Whether the request was processed successfully. Declines return HTTP 200 with success: false.
true
Human-readable result message.
"succeeded"
Machine-readable result code. See the Error Codes reference.
"0"
The response payload.
Hide child attributes
Hide child attributes
Internal document identifier.
"67c24dd60621becf9a41813e"
Unique identifier of the submerchant.
"jpt-sim-md-1"
Identifier of the Service Provider product the merchant belongs to.
"255"
Facilitator identifier assigned by Jupico.
"JPT"
Gross sales in the settlement.
47090
Refund amount.
0
Chargebacks linked to this transaction.
0
Tax amount withheld.
0
Sales minus refunds and chargebacks.
45706.67
Identifiers of fee records included.
Timestamp when the object was created (ISO 8601).
"2025-02-28T23:59:18.385Z"
Timestamp when the object was last updated (ISO 8601).
"2025-02-28T23:59:18.385Z"
Portion of the fee billed at the platform level.
1312.01
Portion of the fee billed at the Service Provider product level.
71.32
Interchange fee amount passed through.
0
Total fees deducted.
1383.33
Net amount payable to the Service Provider product.
71.32
Aggregate totals across all returned records.
Hide child attributes
Hide child attributes
Internal document identifier.
null
Number of records.
23
Gross sales in the settlement.
85318.68
Total refunds in the settlement.
0
Sales minus refunds and chargebacks.
82725.1
Total chargebacks in the settlement.
0
Tax amount withheld.
0
Number of fee records in the settlement.
324
Total fees at the platform level.
2445.85
Total fees at the Service Provider product level.
147.73
Interchange pass-through fee settings.
0
Total fees deducted.
2593.58
Net amount payable to the Service Provider product.
147.73
Was this page helpful?