The Payouts model will allow you to track funds you’ve received from SumUp.
You can receive a detailed payouts list with information like dates, fees, references and statuses, using the List payouts endpoint.
The Financial Payouts object
Ordered list of payout and payout-deduction records.
- idintegerrequired
Unique identifier of the payout-related record.
Example:123456789 - typestringrequiredOptions:
PAYOUTCHARGE_BACK_DEDUCTIONREFUND_DEDUCTIONDD_RETURN_DEDUCTIONBALANCE_DEDUCTIONHigh-level payout record category.
Example:"PAYOUT" - amountnumberrequired
Amount of the payout or deduction in major units.
Example:132.45 - datestringrequiredformat: date
Payout date associated with the record, in
YYYY-MM-DDformat.Example:"2024-02-29" - currencystringrequired
Three-letter ISO 4217 currency code of the payout.
Example:"EUR" - feenumberrequired
Fee amount associated with the payout record, in major units.
Example:3.12 - statusstringrequiredOptions:
SUCCESSFULFAILEDMerchant-facing outcome of the payout record.
Example:"SUCCESSFUL" - referencestringrequired
Processor or payout reference associated with the record.
Example:"payout-2024-02-29" - transaction_codestringrequired
Transaction code of the original sale associated with the payout or deduction.
Example:"TEENSK4W2K"
[
{
"id": 123456789,
"type": "PAYOUT",
"amount": 132.45,
"date": "2024-02-29",
"currency": "EUR",
"fee": 3.12,
"status": "SUCCESSFUL",
"reference": "payout-2024-02-29",
"transaction_code": "TEENSK4W2K"
}
]List payouts
Lists payout and payout-deduction records for the specified merchant account within the requested date range.
The response can include:
- regular payouts (
type = PAYOUT) - deduction records for refunds, chargebacks, direct debit returns, or balance adjustments
Results are sorted by payout date in the requested order.
user.profileuser.profile_readonlypayouts.readPath Parameters
- merchant_codestringrequired
Short unique identifier for the merchant.
Example:"MH4H92C7"
Query Parameters
- start_datestringrequiredformat: date
Start date of the payout period filter, inclusive, in ISO8601
dateformat (YYYY-MM-DD).Example:"2024-02-01" - end_datestringrequiredformat: date
End date of the payout period filter, inclusive, in ISO8601
dateformat (YYYY-MM-DD). Must be greater than or equal tostart_date.Example:"2024-02-29" - formatstringdefault:
jsonOptions:jsoncsvResponse format for the payout list.
Example:"json" - limitintegerminimum: 1, maximum: 9999
Maximum number of payout records to return.
Example:10 - orderstringdefault:
ascOptions:ascdescSort direction for the returned payouts.
Example:"desc"
Response
Returns the list of payout and deduction records for the requested period. See FinancialPayouts object.
- idintegerrequired
Unique identifier of the payout-related record.
Example:123456789 - typestringrequiredOptions:
PAYOUTCHARGE_BACK_DEDUCTIONREFUND_DEDUCTIONDD_RETURN_DEDUCTIONBALANCE_DEDUCTIONHigh-level payout record category.
Example:"PAYOUT" - amountnumberrequired
Amount of the payout or deduction in major units.
Example:132.45 - datestringrequiredformat: date
Payout date associated with the record, in
YYYY-MM-DDformat.Example:"2024-02-29" - currencystringrequired
Three-letter ISO 4217 currency code of the payout.
Example:"EUR" - feenumberrequired
Fee amount associated with the payout record, in major units.
Example:3.12 - statusstringrequiredOptions:
SUCCESSFULFAILEDMerchant-facing outcome of the payout record.
Example:"SUCCESSFUL" - referencestringrequired
Processor or payout reference associated with the record.
Example:"payout-2024-02-29" - transaction_codestringrequired
Transaction code of the original sale associated with the payout or deduction.
Example:"TEENSK4W2K"
curl https://api.sumup.com/v1.0/merchants/{merchant_code}/payouts \
-X GET \
-H "Authorization: Bearer $SUMUP_API_KEY"import SumUp from '@sumup/sdk';
const client = new SumUp();
const result = await client.payouts.list("MH4H92C7", "2024-02-01", "2024-02-29");using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Threading.Tasks;
using SumUp;
public static class Program
{
public static async Task Main()
{
using var client = new SumUpClient();
var response = await client.Payouts.ListAsync(
"your-merchant-code",
new PayoutsListOptions
{
StartDate = DateOnly.Parse("2025-01-01"),
EndDate = DateOnly.Parse("2025-01-01"),
Format = "example",
Limit = 10,
Order = "example",
});
Console.WriteLine(response.StatusCode);
}
}import com.sumup.sdk.SumUpClient;
public final class ListPayoutsV1Sample {
public static void main(String[] args) throws Exception {
var client = new SumUpClient();
var result = client.payouts().list(
"MH4H92C7",
java.time.LocalDate.parse("2024-02-29"),
java.time.LocalDate.parse("2024-02-01")
);
System.out.println(result);
}
}import os
import sumup
def main() -> None:
client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])
result = client.payouts.list(
"MH4H92C7",
start_date="2024-02-01",
end_date="2024-02-29",
format="json",
limit=10,
order="desc",
)
print(result)
if __name__ == "__main__":
main()<?php
$sumup = new \SumUp\SumUp();
$result = $sumup->payouts->list('MH4H92C7', '2024-02-01', '2024-02-29');package main
import (
"context"
"log"
"time"
"github.com/sumup/sumup-go"
"github.com/sumup/sumup-go/datetime"
)
func main() {
ctx := context.Background()
client := sumup.NewClient()
result, err := client.Payouts.List(ctx, "MH4H92C7", sumup.PayoutsListParams{
StartDate: datetime.NewDate(2024, time.February, 1),
EndDate: datetime.NewDate(2024, time.February, 29),
Format: ptr(sumup.PayoutsListFormat("json")),
Limit: ptr(10),
Order: ptr(sumup.PayoutsListOrder("desc")),
})
if err != nil {
log.Fatal(err)
}
log.Printf("%+v", result)
}
func ptr[T any](value T) *T {
return &value
}use sumup::Client;
let client = Client::default();
let result = client.payouts().list("MH4H92C7", sumup::ListPayoutsV1Params{
start_date: Some("2024-02-01".to_string()),
end_date: Some("2024-02-29".to_string()),
format: Some("json".to_string()),
limit: Some(10),
order: Some("desc".to_string()),
}).await;[
{
"amount": 132.45,
"currency": "EUR",
"date": "2024-02-29",
"fee": 3.12,
"id": 123456789,
"reference": "payout-2024-02-29",
"status": "SUCCESSFUL",
"transaction_code": "TEENSK4W2K",
"type": "PAYOUT"
}
]Content-Type: application/json
The request is invalid for the submitted query parameters.
- messagestring
Short description of the error.
Example:"Resource not found" - error_codestring
Platform code for the error.
Example:"NOT_FOUND" - paramstring
Parameter name (with relative location) to which the error applies. Parameters from embedded resources are displayed using dot notation. For example,
card.namerefers to thenameparameter embedded in thecardobject.Example:"card.name"
Content-Type: application/json
The request is not authorized.
- typestringrequiredformat: uri
A URI reference that identifies the problem type.
Example:"https://developer.sumup.com/problem/not-found" - titlestring
A short, human-readable summary of the problem type.
Example:"Requested resource couldn't be found." - statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.
Example:404 - detailstring
A human-readable explanation specific to this occurrence of the problem.
Example:"The requested resource doesn't exist or does not belong to you." - instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.
Example:"https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"
[
{
"error_code": "MISSING",
"message": "Validation error: required",
"param": "start_date"
},
{
"error_code": "MISSING",
"message": "Validation error: required",
"param": "end_date"
}
]{
"detail": "Unauthorized.",
"status": 401,
"title": "Unauthorized",
"trace_id": "3c77294349d3b5647ea2d990f0d8f017",
"type": "https://developer.sumup.com/problem/unauthorized"
}