List the breakdown of a publisher payment

Prev Next
Get
/v1/publishers/{publisherId}/payments/{paymentId}/breakdowns

Returns a page of the advertisers whose commission makes up one of the publisher's payments, with the net amount from each, ordered by payment descending (largest first) then advertiserId ascending, compared numerically, a stable order that holds across pages. A payment has a limited number of advertiser rows, which is why the results are paged with limit and offset. Use it to show the breakdown of a payment from the publisher's payment history. Read-only, with no side effects. The caller must belong to the publisher account and hold at least the Full Access role on it; otherwise the request is rejected with 403. A payment that does not exist or does not belong to the publisher is not found.

Security
HTTP
Type bearer

Personal Access Token, sent as Authorization: Bearer <token>.

Path parameters
publisherId
stringRequired

Identifier of the publisher account.

Pattern^[0-9]+$
Example45678
paymentId
stringRequired

Identifier of the payment, as returned in paymentId by listPublisherPayments.

Pattern^[0-9]+$
Example9876543
Query parameters
limit
integer

Maximum number of results to return.

Minimum1
Maximum100
Default25
Example25
offset
integer

Number of results to skip. Offsets beyond 10000 are rejected with 400.

Minimum0
Maximum10000
Default0
Example0
Responses
200

A page of the payment's breakdowns. An empty results array means the payment has no breakdowns; this is not an error.

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
object
total
integer

Total number of results across all pages.

Minimum0
Example567
offset
integer

Number of results skipped before this page.

Minimum0
Example200
limit
integer

Maximum number of results in this page.

Minimum1
Example50
results
Array

The results in this page.

400

Bad Request

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Bad Request",
  "status": 400,
  "detail": "Required parameters are missing from the request",
  "code": "VALIDATION_FAILED",
  "errors": [
    {
      "pointer": "/name",
      "detail": "must be 100 characters or fewer"
    }
  ]
}
Expand All
object
type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
errors
Array of object

One entry per field that failed validation.

object
pointer
string

An RFC 6901 JSON Pointer to the offending field in the request.

Example/name
detail
string

A human-readable explanation of this field's failure.

Examplemust be 100 characters or fewer
401

Unauthorized

{
  "type": "https://help.awin.com/apis/error",
  "title": "Unauthorized",
  "status": 401,
  "detail": "No valid credentials were supplied with the request",
  "code": "UNAUTHORIZED"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
403

Forbidden

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Forbidden",
  "status": 403,
  "detail": "You do not have the correct privileges to access this resource",
  "code": "FORBIDDEN"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
404

Not Found

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Not Found",
  "status": 404,
  "detail": "Resource not found with that ID",
  "code": "NOT_FOUND"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
429

Too Many Requests

Headers
Retry-After
integerRequired
Number of seconds to wait before retrying the request.
Minimum0
Example1
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
userRateLimitExceeded
{
  "type": "https://help.awin.com/apis/error",
  "title": "User rate limit exceeded",
  "status": 429,
  "detail": "You have exceeded your rate limit across the public API. Retry after the number of seconds in the Retry-After header",
  "code": "USER_RATE_LIMIT_EXCEEDED"
}
routeRateLimitExceeded
{
  "type": "https://help.awin.com/apis/error",
  "title": "Route rate limit exceeded",
  "status": 429,
  "detail": "This endpoint is receiving more requests than it can accept right now. Retry after the number of seconds in the Retry-After header",
  "code": "ROUTE_RATE_LIMIT_EXCEEDED"
}
tooManyRequests
{
  "type": "https://help.awin.com/apis/error",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "Rate limit exceeded",
  "code": "TOO_MANY_REQUESTS"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
503

Service Unavailable

Headers
Retry-After
integerRequired
Number of seconds to wait before retrying the request.
Minimum0
Example1
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "The service is temporarily unavailable",
  "code": "SERVICE_UNAVAILABLE"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
default

Internal Server Error

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND