> ## Documentation Index > Fetch the complete documentation index at: https://help.awin.com/llms.txt > Use this file to discover all available pages before exploring further. # Get prepayment account status > 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`. ## OpenAPI ````json GET /v1/advertisers/{advertiserId}/prepayments { "openapi": "3.0.3", "info": { "title": "Awin Public API", "version": "0.1.0" }, "servers": [ { "url": "https://api.awin.com/public", "description": "Production" } ], "tags": [ { "name": "Advertisers", "description": "Endpoints for advertiser accounts." }, { "name": "Advertisers > Partnerships", "description": "Advertiser partnerships with publishers." }, { "name": "Advertisers > Tracking links", "description": "Advertiser tracking links." }, { "name": "Advertisers > Billing", "description": "Advertiser billing and prepayments." }, { "name": "Publishers", "description": "Endpoints for publisher accounts." }, { "name": "Publishers > Partnerships", "description": "Publisher partnerships with advertisers." }, { "name": "Publishers > Transactions", "description": "Publisher transactions." }, { "name": "Publishers > Payments", "description": "Publisher payments and payment details." } ], "paths": { "/v1/advertisers/{advertiserId}/prepayments": { "x-awin-owner": "hqteamartemis", "parameters": [ { "$ref": "#/components/parameters/AdvertiserId" } ], "get": { "tags": [ "Advertisers > Billing" ], "operationId": "getAdvertiserPrepayments", "summary": "Get prepayment account status", "description": "Returns the current state of an advertiser's prepayments account.\n\nUse this endpoint when you need the full prepayments account snapshot\nfor account review, monitoring, or operational checks.\n\n`linkStatus.statusChangedAt` is omitted when the link status has never\nchanged: the link has been `ONLINE` since the advertiser joined\nprepayments.\n\nThis operation is read-only and has no side effects; it does not\nmodify the advertiser account or payment configuration.\n\nThe caller must belong to the advertiser account and hold the Viewer\nrole or higher on it; otherwise the request is rejected with `403`.\nNo product entitlement is required. An advertiser account that has no\nprepayments account returns `404` with code `NOT_FOUND`.\n", "x-awin-audience": "public", "x-awin-public-api-authorization": { "accountType": "advertiser", "minRole": "userViewer" }, "responses": { "200": { "description": "The advertiser's current prepayments account state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvertiserPrepayments" }, "examples": { "advertiserPrepayments": { "summary": "Advertiser prepayments", "value": { "advertiserId": "1001", "availableBalance": { "amount": "1250.75", "currency": "USD" }, "linkStatus": { "status": "ONLINE", "statusChangedAt": "2026-09-28T10:45:00Z" }, "autoDepositEnabled": true, "primaryPaymentMethodConfigured": true, "secondaryPaymentMethodConfigured": false } }, "neverChanged": { "summary": "Link status has never changed", "value": { "advertiserId": "1002", "availableBalance": { "amount": "0.00", "currency": "GBP" }, "linkStatus": { "status": "ONLINE" }, "autoDepositEnabled": false, "primaryPaymentMethodConfigured": true, "secondaryPaymentMethodConfigured": false } } } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/UnexpectedError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "patBearer": [] } ] } } }, "components": { "parameters": { "AdvertiserId": { "name": "advertiserId", "in": "path", "required": true, "description": "Identifier of the advertiser account.", "schema": { "type": "string", "pattern": "^[0-9]+$", "example": "1001" } } }, "schemas": { "AdvertiserPrepayments": { "type": "object", "description": "Current prepayments account state for an advertiser.", "required": [ "advertiserId", "availableBalance", "linkStatus", "autoDepositEnabled", "primaryPaymentMethodConfigured", "secondaryPaymentMethodConfigured" ], "properties": { "advertiserId": { "allOf": [ { "$ref": "#/components/schemas/AdvertiserId" } ], "description": "Identifier of the advertiser account." }, "availableBalance": { "allOf": [ { "$ref": "#/components/schemas/Money" } ], "description": "Amount available to the advertiser for payment processing and settlement at the time represented by this account state." }, "linkStatus": { "allOf": [ { "$ref": "#/components/schemas/AdvertiserPrepaymentsLinkStatus" } ], "description": "Current status of the advertiser payment link." }, "autoDepositEnabled": { "type": "boolean", "description": "Indicates whether automatic deposits are enabled for the account.", "example": true }, "primaryPaymentMethodConfigured": { "type": "boolean", "description": "Indicates whether the primary payment method is configured for the account.", "example": true }, "secondaryPaymentMethodConfigured": { "type": "boolean", "description": "Indicates whether the secondary payment method is configured for the account.", "example": false } } }, "AdvertiserId": { "type": "string", "pattern": "^[0-9]+$", "description": "Identifier of the advertiser account.", "example": "1001" }, "Money": { "type": "object", "description": "A monetary value: a decimal amount paired with its currency. MUST NOT carry any other property; a resource with several monetary values holds one `Money` per role, named by the role.", "additionalProperties": false, "required": [ "amount", "currency" ], "properties": { "amount": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$", "description": "Decimal string amount. Transported as a string, not a number, since floating point cannot represent decimal currency values exactly.", "example": "125.50" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code, uppercase.", "example": "GBP" } } }, "AdvertiserPrepaymentsLinkStatus": { "type": "object", "description": "Link status for an advertiser prepayments account. Includes link availability and time of last status change.", "required": [ "status" ], "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/AdvertiserPrepaymentsLinkStatusValue" } ], "description": "Status of the advertiser payment link at the time represented by this record." }, "statusChangedAt": { "type": "string", "format": "date-time", "description": "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.", "example": "2026-09-28T10:45:00Z" } } }, "ValidationProblem": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "type": "object", "description": "A problem detail carrying the RFC 9457 extension member `errors`, used where a request fails validation on one or more specific fields.", "properties": { "errors": { "type": "array", "description": "One entry per field that failed validation.", "items": { "type": "object", "required": [ "pointer", "detail" ], "properties": { "pointer": { "type": "string", "description": "An [RFC 6901](https://www.rfc-editor.org/rfc/rfc6901) JSON Pointer to the offending field in the request.", "example": "/name" }, "detail": { "type": "string", "description": "A human-readable explanation of this field's failure.", "example": "must be 100 characters or fewer" } } } } } } ] }, "Problem": { "type": "object", "description": "Problem details for an HTTP API error, as defined by [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). Served as `application/problem+json`.", "required": [ "title", "status", "detail", "code" ], "properties": { "type": { "type": "string", "format": "uri-reference", "default": "https://help.awin.com/apis/error", "description": "A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.", "example": "https://help.awin.com/apis/error" }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.", "example": "Not Found" }, "status": { "type": "integer", "description": "The HTTP status code, repeated here for convenience.", "example": 404 }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.", "example": "Resource not found with that ID" }, "instance": { "type": "string", "format": "uri-reference", "description": "A URI reference identifying this specific occurrence, typically the request path.", "example": "/v1/advertisers/12345/prepayments" }, "code": { "type": "string", "description": "A stable, machine-readable error code. It does not change when `detail` is reworded, so clients branch on `code`, never on `detail`.", "enum": [ "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" ], "example": "NOT_FOUND" } } }, "AdvertiserPrepaymentsLinkStatusValue": { "type": "string", "description": "Status of an advertiser prepayments payment link.", "enum": [ "ONLINE", "OFFLINE" ], "example": "ONLINE" } }, "headers": { "RateLimitLimit": { "description": "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.", "schema": { "type": "integer", "minimum": 1, "example": 5 } }, "RateLimitRemaining": { "description": "Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 0, "example": 0 } }, "RateLimitReset": { "description": "Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 0, "example": 1 } }, "RetryAfter": { "description": "Number of seconds to wait before retrying the request.", "required": true, "schema": { "type": "integer", "minimum": 0, "example": 1 } } }, "responses": { "BadRequest": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblem" }, "example": { "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" } ] } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "Unauthorized": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Unauthorized", "status": 401, "detail": "No valid credentials were supplied with the request", "code": "UNAUTHORIZED" } } } }, "Forbidden": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "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" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "NotFound": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Not Found", "status": 404, "detail": "Resource not found with that ID", "code": "NOT_FOUND" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "TooManyRequests": { "description": "Too Many Requests", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "userRateLimitExceeded": { "value": { "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": { "value": { "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": { "value": { "type": "https://help.awin.com/apis/error", "title": "Too Many Requests", "status": 429, "detail": "Rate limit exceeded", "code": "TOO_MANY_REQUESTS" } } } } } }, "UnexpectedError": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Internal Server Error", "status": 500, "detail": "An unexpected error occurred", "code": "INTERNAL_ERROR" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "ServiceUnavailable": { "description": "Service Unavailable", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Service Unavailable", "status": 503, "detail": "The service is temporarily unavailable", "code": "SERVICE_UNAVAILABLE" } } } } }, "securitySchemes": { "patBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Personal Access Token, sent as `Authorization: Bearer `." } } } } ````