Payouts | SumUp Developer

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.

[]object

Show attributes

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

Options: SUCCESSFULFAILED
transaction_code string
type string

Options: PAYOUTCHARGE_BACK_DEDUCTIONREFUND_DEDUCTIONDD_RETURN_DEDUCTIONBALANCE_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

GET /v1.0/merchants/{merchant_code}/payouts

Lists ordered payouts for the merchant account.

Required scopes: user.profileuser.profile_readonly

Path Parameters

merchant_code string required

Merchant code of the account whose payouts should be listed.

Example: "MH4H92C7"

Query Parameters

start_date string required format: date

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

End date (in ISO8601 format).
format string

Options: jsoncsv

Response format for the payout list.

Example: "json"
limit integer

Maximum number of payout records to return.

Example: 10
order string

Options: descasc

Sort direction for the returned payouts.

Example: "desc"

Response

Returns the list of payouts for the requested period. See FinancialPayouts object .

[]object

Show attributes

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

Options: SUCCESSFULFAILED
transaction_code string
type string

Options: PAYOUTCHARGE_BACK_DEDUCTIONREFUND_DEDUCTIONDD_RETURN_DEDUCTIONBALANCE_DEDUCTION

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("json".to_string()),
9
    limit: Some(10),
10
    order: Some("desc".to_string()),
11
}).await;

1
[
2
  {
3
    "amount": 132.45,
4
    "currency": "EUR",
5
    "date": "2024-02-29",
6
    "fee": 3.12,
7
    "id": 123456789,
8
    "reference": "payout-2024-02-29",
9
    "status": "SUCCESSFUL",
10
    "transaction_code": "TEENSK4W2K",
11
    "type": "PAYOUT"
12
  }
13
]

Error 400
Error 401

Content-Type: application/json

The request is invalid for the submitted query parameters.

[]ErrorExtended

Show attributes

message string

Short description of the error.

Example: "Resource not found"
error_code string

Platform code for the error.

Example: "NOT_FOUND"
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.

Content-Type: application/json

The request is not authorized.

type string required format: uri

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 format: uri

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

Error 400
Error 401

1
[
2
  {
3
    "error_code": "MISSING",
4
    "message": "Validation error: required",
5
    "param": "start_date"
6
  },
7
  {
8
    "error_code": "MISSING",
9
    "message": "Validation error: required",
10
    "param": "end_date"
11
  }
12
]

1
{
2
  "detail": "Unauthorized.",
3
  "status": 401,
4
  "title": "Unauthorized",
5
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
6
  "type": "https://developer.sumup.com/problem/unauthorized"
7
}

Payouts

List payoutsDeprecated

GET /v0.1/me/financials/payouts

Lists ordered payouts for the merchant account.

Required scopes: user.profileuser.profile_readonly

Query Parameters

start_date string required format: date

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

End date (in ISO8601 format).
format string

Options: jsoncsv

Response format for the payout list.

Example: "json"
limit integer

Maximum number of payout records to return.

Example: 10
order string

Options: descasc

Sort direction for the returned payouts.

Example: "desc"

Response

Returns the list of payouts for the requested period. See FinancialPayouts object .

[]object

Show attributes

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

Options: SUCCESSFULFAILED
transaction_code string
type string

Options: PAYOUTCHARGE_BACK_DEDUCTIONREFUND_DEDUCTIONDD_RETURN_DEDUCTIONBALANCE_DEDUCTION

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("json".to_string()),
9
    limit: Some(10),
10
    order: Some("desc".to_string()),
11
}).await;

1
[
2
  {
3
    "amount": 132.45,
4
    "currency": "EUR",
5
    "date": "2024-02-29",
6
    "fee": 3.12,
7
    "id": 123456789,
8
    "reference": "payout-2024-02-29",
9
    "status": "SUCCESSFUL",
10
    "transaction_code": "TEENSK4W2K",
11
    "type": "PAYOUT"
12
  }
13
]

Error 400
Error 401

Content-Type: application/json

The request is invalid for the submitted query parameters.

[]ErrorExtended

Show attributes

message string

Short description of the error.

Example: "Resource not found"
error_code string

Platform code for the error.

Example: "NOT_FOUND"
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.

Content-Type: application/json

The request is not authorized.

type string required format: uri

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 format: uri

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

Error 400
Error 401

1
[
2
  {
3
    "error_code": "MISSING",
4
    "message": "Validation error: required",
5
    "param": "start_date"
6
  },
7
  {
8
    "error_code": "MISSING",
9
    "message": "Validation error: required",
10
    "param": "end_date"
11
  }
12
]

1
{
2
  "detail": "Unauthorized.",
3
  "status": 401,
4
  "title": "Unauthorized",
5
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
6
  "type": "https://developer.sumup.com/problem/unauthorized"
7
}