Payouts

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

List of payout summaries.

Financial Payouts

[]object

Show attributes

amount number
currency string
date string date
fee number
id integer
reference string
status string

Options: SUCCESSFUL FAILED
transaction_code string
type string

Options: PAYOUT CHARGE_BACK_DEDUCTION REFUND_DEDUCTION DD_RETURN_DEDUCTION BALANCE_DEDUCTION

1
[
2
  {
3
    "amount": null,
4
    "currency": null,
5
    "date": null,
6
    "fee": null,
7
    "id": null,
8
    "reference": null,
9
    "status": null,
10
    "transaction_code": null,
11
    "type": null
12
  }
13
]

Payouts

List payouts

Lists ordered payouts for the merchant profile.

Required scopes: user.profile user.profile_readonly

Path Parameters

merchant_code string required

Example: "MH4H92C7"

Query Parameters

start_date string date required

Start date (in ISO8601 format).
end_date string date required

End date (in ISO8601 format).
format string

Options: json csv
limit integer
order string

Options: desc asc

Response 400

[]object

Show attributes

message string

Short description of the error.
error_code string

Platform code for the error.
param string

Parameter name (with relative location) to which the error applies. Parameters from embedded resources are displayed using dot notation. For example, card.name refers to the name parameter embedded in the card object.

Problem

type string uri required

A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
title string

A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
status integer

The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detail string

A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instance string uri

A URI reference that identifies the specific occurrence of the problem.

1
curl https://api.sumup.com/v1.0/merchants/{merchant_code}/payouts \
2
 -X GET \
3
 -H "Authorization: Bearer $SUMUP_API_KEY"

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.payouts.list("MH4H92C7", "start_date", "end_date");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Payouts.ListAsync(
6
    "MH4H92C7",
7
    "start_date",
8
    "end_date"
9
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.payouts().listPayoutsV1(
6
  "MH4H92C7",
7
  java.time.LocalDate.parse("start_date"),
8
  java.time.LocalDate.parse("end_date")
9
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.payouts.list("MH4H92C7", "start_date", "end_date")

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->payouts->list('MH4H92C7', 'start_date', 'end_date');

1
client := sumup.NewClient()
2

3
result, err := client.Payouts.List(context.Background(), "MH4H92C7", "start_date", "end_date")

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.payouts().list("MH4H92C7", sumup::ListPayoutsV1Params{
6
    start_date: Some("start_date".to_string()),
7
    end_date: Some("end_date".to_string()),
8
    format: Some("format".to_string()),
9
    limit: Some("limit".to_string()),
10
    order: Some("order".to_string()),
11
}).await;

1
[
2
  {
3
    "amount": null,
4
    "currency": null,
5
    "date": null,
6
    "fee": null,
7
    "id": null,
8
    "reference": null,
9
    "status": null,
10
    "transaction_code": null,
11
    "type": null
12
  }
13
]

Payouts

List payoutsDeprecated

Lists ordered payouts for the merchant profile.

Required scopes: user.profile user.profile_readonly

Query Parameters

start_date string date required

Start date (in ISO8601 format).
end_date string date required

End date (in ISO8601 format).
format string

Options: json csv
limit integer
order string

Options: desc asc

Response 400

[]object

Show attributes

message string

Short description of the error.
error_code string

Platform code for the error.
param string

Parameter name (with relative location) to which the error applies. Parameters from embedded resources are displayed using dot notation. For example, card.name refers to the name parameter embedded in the card object.

Problem

type string uri required

A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
title string

A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
status integer

The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detail string

A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instance string uri

A URI reference that identifies the specific occurrence of the problem.

1
curl https://api.sumup.com/v0.1/me/financials/payouts \
2
 -X GET \
3
 -H "Authorization: Bearer $SUMUP_API_KEY"

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.payouts.listDeprecated("start_date", "end_date");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Payouts.ListDeprecatedAsync(
6
    "start_date",
7
    "end_date"
8
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.payouts().listPayouts(
6
  java.time.LocalDate.parse("start_date"),
7
  java.time.LocalDate.parse("end_date")
8
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.payouts.list_deprecated("start_date", "end_date")

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->payouts->listDeprecated('start_date', 'end_date');

1
client := sumup.NewClient()
2

3
result, err := client.Payouts.ListDeprecated(context.Background(), "start_date", "end_date")

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.payouts().list_deprecated(sumup::ListPayoutsParams{
6
    start_date: Some("start_date".to_string()),
7
    end_date: Some("end_date".to_string()),
8
    format: Some("format".to_string()),
9
    limit: Some("limit".to_string()),
10
    order: Some("order".to_string()),
11
}).await;

1
[
2
  {
3
    "amount": null,
4
    "currency": null,
5
    "date": null,
6
    "fee": null,
7
    "id": null,
8
    "reference": null,
9
    "status": null,
10
    "transaction_code": null,
11
    "type": null
12
  }
13
]