Get tax profile

Prev Next
Get
/v1/publishers/{publisherId}/tax-profile

Returns the tax profile on file for the publisher. Use it to check the tax residency and registration details held for a publisher's payments. The response always carries taxResidency and taxCompleted; when taxResidency is BR the Brazil-specific fields (cnpjLast4, saoPauloRegistered, cpfLast4, pisLast4) are also returned, and when it is MX the Mexico-specific fields (taxRegime, rfcNumberLast4) are returned instead. Tax identifiers are masked: only their last four characters are returned. Fields with no recorded value are omitted. Returns 404 if the publisher has no tax profile on file. 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.

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
Responses
200

The publisher's tax profile.

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
Expand All
object

Tax profile recorded for a publisher. The common fields apply to every tax residency. The Brazil-specific fields are returned only when taxResidency is BR, and the Mexico-specific fields only when taxResidency is MX; for any other residency they are omitted. Fields with no recorded value are omitted. Tax identifiers are never returned in full; only their last four characters are returned, in the *Last4 fields. New fields and new enum values may be added without a new major version (APIG-6.1, APIG-4A.8); a consumer MUST treat an unrecognised enum value as a non-fatal case.

taxResidency
string

ISO 3166-1 alpha-2 code of the country the publisher is tax resident in. Determines which country-specific fields are returned.

Pattern^[A-Z]{2}$
ExampleBR
businessType
string

Type of business the publisher is registered as. New values may be added without a new major version; a consumer MUST tolerate an unrecognised value.

Valid values[ "REGISTERED_COMPANY", "MICRO_ENTREPRENEUR", "SOLE_TRADER", "REGISTERED_COMPANY_GLOBAL", "SOLE_TRADER_GLOBAL", "C_CORPORATION", "S_CORPORATION", "PARTNERSHIP", "TRUST_ESTATE", "LIMITED_LIABILITY_COMPANY_C", "LIMITED_LIABILITY_COMPANY_S", "LIMITED_LIABILITY_COMPANY_P", "INDIVIDUAL_SOLE_PROPRIETOR_OR_SINGLE_MEMBER_LLC" ]
ExampleREGISTERED_COMPANY
companyName
string

Registered company name. Omitted if not recorded.

Max length200
ExampleExample Ltda
taxCompleted
boolean

Whether the publisher has completed their tax profile.

Exampletrue
euVatRegistered
boolean

Whether the publisher is registered for VAT in the EU.

Examplefalse
localTaxNumberLast4
string

Last four characters of the tax number issued by the publisher's local tax authority, ignoring spaces and punctuation. Fewer than four characters are returned if the recorded number is shorter. The full number is not returned. Not returned when the tax number is a CNPJ, CPF or RFC; those are returned in cnpjLast4, cpfLast4 and rfcNumberLast4.

Pattern^[A-Za-z0-9]{1,4}$
Example5678
address
object

Address recorded for the publisher's tax profile.

addressLine1
string

First line of the address. Omitted if not recorded.

Max length200
Example1 Example Street
addressLine2
string

Second line of the address. Omitted if not recorded.

Max length200
ExampleFloor 2
city
string

City or town. Omitted if not recorded.

Max length100
ExampleLondon
region
string

State, province or region. Omitted if not recorded.

Max length100
ExampleGreater London
postalCode
string

Postal or ZIP code. Omitted if not recorded.

Max length20
ExampleEC1A 1BB
country
string

ISO 3166-1 alpha-2 code of the address country.

Pattern^[A-Z]{2}$
ExampleGB
cnpjLast4
string

Brazil only (taxResidency is BR). Last four digits of the CNPJ, the Brazilian company tax registration number. The full number is not returned.

Pattern^[0-9]{4}$
Example0195
saoPauloRegistered
boolean

Brazil only (taxResidency is BR). Whether the publisher is registered in São Paulo.

Exampletrue
cpfLast4
string

Brazil only (taxResidency is BR). Last four digits of the CPF, the Brazilian individual taxpayer registration number. The full number is not returned.

Pattern^[0-9]{4}$
Example8909
pisLast4
string

Brazil only (taxResidency is BR). Last four digits of the PIS, the Brazilian social integration programme number. The full number is not returned.

Pattern^[0-9]{4}$
Example8919
taxRegime
string

Mexico only (taxResidency is MX). Tax regime the publisher is registered under. New values may be added without a new major version; a consumer MUST tolerate an unrecognised value.

Valid values[ "GENERAL", "INDIVIDUALS_WITH_BUSINESS_AND_PROFESSIONAL_ACTIVITIES", "SIMPLIFIED_TRUST_REGIME" ]
ExampleGENERAL
rfcNumberLast4
string

Mexico only (taxResidency is MX). Last four characters of the RFC, the Mexican federal taxpayer registry number. The full number is not returned.

Pattern^[A-Z0-9]{4}$
Example1000
updatedAt
string (date-time)

When the tax profile was last updated, as an RFC 3339 UTC timestamp with a Z offset.

Example2026-07-21T09:14:23.123Z
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