Returns the current state of an advertiser's prepayments account.
Use this endpoint when you need the full prepayments account snapshot for account review, monitoring, or operational checks.
linkStatus.statusChangedAt is omitted when the link status has never
changed: the link has been ONLINE since the advertiser joined
prepayments.
This operation is read-only and has no side effects; it does not modify the advertiser account or payment configuration.
The caller must belong to the advertiser account and hold the Viewer
role or higher on it; otherwise the request is rejected with 403.
No product entitlement is required. An advertiser account that has no
prepayments account returns 404 with code NOT_FOUND.
Personal Access Token, sent as Authorization: Bearer <token>.
Identifier of the advertiser account.
The advertiser's current prepayments account state.
Advertiser prepayments
{
"advertiserId": "1001",
"availableBalance": {
"amount": "1250.75",
"currency": "USD"
},
"linkStatus": {
"status": "ONLINE",
"statusChangedAt": "2026-09-28T10:45:00Z"
},
"autoDepositEnabled": true,
"primaryPaymentMethodConfigured": true,
"secondaryPaymentMethodConfigured": false
}Link status has never changed
{
"advertiserId": "1002",
"availableBalance": {
"amount": "0.00",
"currency": "GBP"
},
"linkStatus": {
"status": "ONLINE"
},
"autoDepositEnabled": false,
"primaryPaymentMethodConfigured": true,
"secondaryPaymentMethodConfigured": false
}Current prepayments account state for an advertiser.
Identifier of the advertiser account.
Amount available to the advertiser for payment processing and settlement at the time represented by this account state.
Decimal string amount. Transported as a string, not a number, since floating point cannot represent decimal currency values exactly.
ISO 4217 currency code, uppercase.
Current status of the advertiser payment link.
Status of the advertiser payment link at the time represented by this record.
Date and time at which this link status took effect. Omitted when the link status has never changed, meaning the link has been ONLINE since the advertiser joined prepayments.
Indicates whether automatic deposits are enabled for the account.
Indicates whether the primary payment method is configured for the account.
Indicates whether the secondary payment method is configured for the account.
Bad Request
{
"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"
}
]
}A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
One entry per field that failed validation.
A human-readable explanation of this field's failure.
Unauthorized
{
"type": "https://help.awin.com/apis/error",
"title": "Unauthorized",
"status": 401,
"detail": "No valid credentials were supplied with the request",
"code": "UNAUTHORIZED"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Forbidden
{
"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"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Not Found
{
"type": "https://help.awin.com/apis/error",
"title": "Not Found",
"status": 404,
"detail": "Resource not found with that ID",
"code": "NOT_FOUND"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Too Many Requests
{
"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"
}{
"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"
}{
"type": "https://help.awin.com/apis/error",
"title": "Too Many Requests",
"status": 429,
"detail": "Rate limit exceeded",
"code": "TOO_MANY_REQUESTS"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Internal Server Error
{
"type": "https://help.awin.com/apis/error",
"title": "Internal Server Error",
"status": 500,
"detail": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Service Unavailable
{
"type": "https://help.awin.com/apis/error",
"title": "Service Unavailable",
"status": 503,
"detail": "The service is temporarily unavailable",
"code": "SERVICE_UNAVAILABLE"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.